Hi! This is an area for us to collaborate as a team
" + body_version: + description: The current version of the body content. If provided, this + update operation will be rejected if the given version does not match + the latest version on the server. + type: string + examples: + - 0307116bbf7ced493b8d8a346c650b71 + comments_count: + type: integer + examples: + - 0 + comments_url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/2343027/discussions/1/comments + created_at: + type: string + format: date-time + examples: + - '2018-01-25T18:56:31Z' + last_edited_at: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + examples: + - https://github.com/orgs/github/teams/justice-league/discussions/1 + node_id: + type: string + examples: + - MDE0OlRlYW1EaXNjdXNzaW9uMQ== + number: + description: The unique sequence number of a team discussion. + type: integer + examples: + - 42 + pinned: + description: Whether or not this discussion should be pinned for easy retrieval. + type: boolean + examples: + - true + private: + description: Whether or not this discussion should be restricted to team + members and organization administrators. + type: boolean + examples: + - true + team_url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/2343027 + title: + description: The title of the discussion. + type: string + examples: + - How can we improve our workflow? + updated_at: + type: string + format: date-time + examples: + - '2018-01-25T18:56:31Z' + url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/2343027/discussions/1 + reactions: + "$ref": "#/components/schemas/reaction-rollup" + required: + - author + - body + - body_html + - body_version + - comments_count + - comments_url + - created_at + - last_edited_at + - html_url + - pinned + - private + - node_id + - number + - team_url + - title + - updated_at + - url + team-discussion-comment: + title: Team Discussion Comment + description: A reply to a discussion within a team. + type: object + properties: + author: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + body: + description: The main text of the comment. + type: string + examples: + - I agree with this suggestion. + body_html: + type: string + examples: + - "Do you like apples?
" + body_version: + description: The current version of the body content. If provided, this + update operation will be rejected if the given version does not match + the latest version on the server. + type: string + examples: + - 0307116bbf7ced493b8d8a346c650b71 + created_at: + type: string + format: date-time + examples: + - '2018-01-15T23:53:58Z' + last_edited_at: + type: + - string + - 'null' + format: date-time + discussion_url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/2403582/discussions/1 + html_url: + type: string + format: uri + examples: + - https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + node_id: + type: string + examples: + - MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= + number: + description: The unique sequence number of a team discussion comment. + type: integer + examples: + - 42 + updated_at: + type: string + format: date-time + examples: + - '2018-01-15T23:53:58Z' + url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 + reactions: + "$ref": "#/components/schemas/reaction-rollup" + required: + - author + - body + - body_html + - body_version + - created_at + - last_edited_at + - discussion_url + - html_url + - node_id + - number + - updated_at + - url + reaction: + title: Reaction + description: Reactions to conversations provide a way to help people express + their feelings more simply and effectively. + type: object + properties: + id: + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDg6UmVhY3Rpb24x + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + content: + description: The reaction to use + type: string + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes + examples: + - heart + created_at: + type: string + format: date-time + examples: + - '2016-05-20T20:09:31Z' + required: + - id + - node_id + - user + - content + - created_at + team-membership: + title: Team Membership + description: Team Membership + type: object + properties: + url: + type: string + format: uri + role: + description: The role of the user in the team. + enum: + - member + - maintainer + default: member + type: string + examples: + - member + state: + description: The state of the user's membership in the team. + type: string + enum: + - active + - pending + required: + - role + - state + - url + team-project: + title: Team Project + description: A team's access to a project. + type: object + properties: + owner_url: + type: string + url: + type: string + html_url: + type: string + columns_url: + type: string + id: + type: integer + node_id: + type: string + name: + type: string + body: + type: + - string + - 'null' + number: + type: integer + state: + type: string + creator: + "$ref": "#/components/schemas/simple-user" + created_at: + type: string + updated_at: + type: string + organization_permission: + description: The organization permission for this project. Only present + when owner is an organization. + type: string + private: + description: Whether the project is private or not. Only present when owner + is an organization. + type: boolean + permissions: + type: object + properties: + read: + type: boolean + write: + type: boolean + admin: + type: boolean + required: + - read + - write + - admin + required: + - owner_url + - url + - html_url + - columns_url + - id + - node_id + - name + - body + - number + - state + - creator + - created_at + - updated_at + - permissions + team-repository: + title: Team Repository + description: A team's access to a repository. + type: object + properties: + id: + description: Unique identifier of the repository + type: integer + examples: + - 42 + node_id: + type: string + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + examples: + - Team Environment + full_name: + type: string + examples: + - octocat/Hello-World + license: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/license-simple" + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + role_name: + type: string + examples: + - admin + owner: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World + description: + type: + - string + - 'null' + examples: + - This your first repo! + fork: + type: boolean + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + examples: + - git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + examples: + - git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + examples: + - https://github.com/octocat/Hello-World.git + mirror_url: + type: + - string + - 'null' + format: uri + examples: + - git:git.example.com/octocat/Hello-World + hooks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + examples: + - https://svn.github.com/octocat/Hello-World + homepage: + type: + - string + - 'null' + format: uri + examples: + - https://github.com + language: + type: + - string + - 'null' + forks_count: + type: integer + examples: + - 9 + stargazers_count: + type: integer + examples: + - 80 + watchers_count: + type: integer + examples: + - 80 + size: + type: integer + examples: + - 108 + default_branch: + description: The default branch of the repository. + type: string + examples: + - master + open_issues_count: + type: integer + examples: + - 0 + is_template: + description: Whether this repository acts as a template that can be used + to generate new repositories. + default: false + type: boolean + examples: + - true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + examples: + - true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + examples: + - true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + examples: + - true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + examples: + - true + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:06:43Z' + created_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:01:12Z' + updated_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:14:43Z' + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + examples: + - true + template_repository: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/repository" + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + examples: + - true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + examples: + - false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + examples: + - false + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + examples: + - true + allow_forking: + description: Whether to allow forking this repo + default: false + type: boolean + examples: + - false + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + examples: + - false + subscribers_count: + type: integer + network_count: + type: integer + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + project-card: + title: Project Card + description: Project cards represent a scope of work. + type: object + properties: + url: + type: string + format: uri + examples: + - https://api.github.com/projects/columns/cards/1478 + id: + description: The project card's ID + type: integer + examples: + - 42 + node_id: + type: string + examples: + - MDExOlByb2plY3RDYXJkMTQ3OA== + note: + type: + - string + - 'null' + examples: + - Add payload for delete Project column + creator: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + examples: + - '2016-09-05T14:21:06Z' + updated_at: + type: string + format: date-time + examples: + - '2016-09-05T14:20:22Z' + archived: + description: Whether or not the card is archived + type: boolean + examples: + - false + column_name: + type: string + project_id: + type: string + column_url: + type: string + format: uri + examples: + - https://api.github.com/projects/columns/367 + content_url: + type: string + format: uri + examples: + - https://api.github.com/repos/api-playground/projects-test/issues/3 + project_url: + type: string + format: uri + examples: + - https://api.github.com/projects/120 + required: + - id + - node_id + - note + - url + - column_url + - project_url + - creator + - created_at + - updated_at + project-column: + title: Project Column + description: Project columns contain cards of work. + type: object + properties: + url: + type: string + format: uri + examples: + - https://api.github.com/projects/columns/367 + project_url: + type: string + format: uri + examples: + - https://api.github.com/projects/120 + cards_url: + type: string + format: uri + examples: + - https://api.github.com/projects/columns/367/cards + id: + description: The unique identifier of the project column + type: integer + examples: + - 42 + node_id: + type: string + examples: + - MDEzOlByb2plY3RDb2x1bW4zNjc= + name: + description: Name of the project column + type: string + examples: + - Remaining tasks + created_at: + type: string + format: date-time + examples: + - '2016-09-05T14:18:44Z' + updated_at: + type: string + format: date-time + examples: + - '2016-09-05T14:22:28Z' + required: + - id + - node_id + - url + - project_url + - cards_url + - name + - created_at + - updated_at + project-collaborator-permission: + title: Project Collaborator Permission + description: Project Collaborator Permission + type: object + properties: + permission: + type: string + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + required: + - permission + - user + rate-limit: + title: Rate Limit + type: object + properties: + limit: + type: integer + remaining: + type: integer + reset: + type: integer + used: + type: integer + required: + - limit + - remaining + - reset + - used + rate-limit-overview: + title: Rate Limit Overview + description: Rate Limit Overview + type: object + properties: + resources: + type: object + properties: + core: + "$ref": "#/components/schemas/rate-limit" + graphql: + "$ref": "#/components/schemas/rate-limit" + search: + "$ref": "#/components/schemas/rate-limit" + source_import: + "$ref": "#/components/schemas/rate-limit" + integration_manifest: + "$ref": "#/components/schemas/rate-limit" + code_scanning_upload: + "$ref": "#/components/schemas/rate-limit" + actions_runner_registration: + "$ref": "#/components/schemas/rate-limit" + scim: + "$ref": "#/components/schemas/rate-limit" + dependency_snapshots: + "$ref": "#/components/schemas/rate-limit" + required: + - core + - search + rate: + "$ref": "#/components/schemas/rate-limit" + required: + - rate + - resources + code-of-conduct-simple: + title: Code Of Conduct Simple + description: Code of Conduct Simple + type: object + properties: + url: + type: string + format: uri + examples: + - https://api.github.com/repos/github/docs/community/code_of_conduct + key: + type: string + examples: + - citizen_code_of_conduct + name: + type: string + examples: + - Citizen Code of Conduct + html_url: + type: + - string + - 'null' + format: uri + examples: + - https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md + required: + - url + - key + - name + - html_url + security-and-analysis: + type: + - object + - 'null' + properties: + advanced_security: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_push_protection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + full-repository: + title: Full Repository + description: Full Repository + type: object + properties: + id: + type: integer + examples: + - 1296269 + node_id: + type: string + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + examples: + - Hello-World + full_name: + type: string + examples: + - octocat/Hello-World + owner: + "$ref": "#/components/schemas/simple-user" + private: + type: boolean + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World + description: + type: + - string + - 'null' + examples: + - This your first repo! + fork: + type: boolean + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + examples: + - git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + examples: + - git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + examples: + - https://github.com/octocat/Hello-World.git + mirror_url: + type: + - string + - 'null' + format: uri + examples: + - git:git.example.com/octocat/Hello-World + hooks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + examples: + - https://svn.github.com/octocat/Hello-World + homepage: + type: + - string + - 'null' + format: uri + examples: + - https://github.com + language: + type: + - string + - 'null' + forks_count: + type: integer + examples: + - 9 + stargazers_count: + type: integer + examples: + - 80 + watchers_count: + type: integer + examples: + - 80 + size: + description: The size of the repository. Size is calculated hourly. When + a repository is initially created, the size is 0. + type: integer + examples: + - 108 + default_branch: + type: string + examples: + - master + open_issues_count: + type: integer + examples: + - 0 + is_template: + type: boolean + examples: + - true + topics: + type: array + items: + type: string + examples: + - octocat + - atom + - electron + - API + has_issues: + type: boolean + examples: + - true + has_projects: + type: boolean + examples: + - true + has_wiki: + type: boolean + examples: + - true + has_pages: + type: boolean + has_downloads: + type: boolean + examples: + - true + has_discussions: + type: boolean + examples: + - true + archived: + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + type: string + examples: + - public + pushed_at: + type: string + format: date-time + examples: + - '2011-01-26T19:06:43Z' + created_at: + type: string + format: date-time + examples: + - '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + examples: + - '2011-01-26T19:14:43Z' + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + required: + - admin + - pull + - push + allow_rebase_merge: + type: boolean + examples: + - true + template_repository: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/repository" + temp_clone_token: + type: + - string + - 'null' + allow_squash_merge: + type: boolean + examples: + - true + allow_auto_merge: + type: boolean + examples: + - false + delete_branch_on_merge: + type: boolean + examples: + - false + allow_merge_commit: + type: boolean + examples: + - true + allow_update_branch: + type: boolean + examples: + - true + use_squash_pr_title_as_default: + type: boolean + examples: + - false + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + examples: + - PR_TITLE + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + examples: + - PR_BODY + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + examples: + - PR_TITLE + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + examples: + - PR_BODY + allow_forking: + type: boolean + examples: + - true + web_commit_signoff_required: + type: boolean + examples: + - false + subscribers_count: + type: integer + examples: + - 42 + network_count: + type: integer + examples: + - 0 + license: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/license-simple" + organization: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + parent: + "$ref": "#/components/schemas/repository" + source: + "$ref": "#/components/schemas/repository" + forks: + type: integer + master_branch: + type: string + open_issues: + type: integer + watchers: + type: integer + anonymous_access_enabled: + description: Whether anonymous git access is allowed. + default: true + type: boolean + code_of_conduct: + "$ref": "#/components/schemas/code-of-conduct-simple" + security_and_analysis: + "$ref": "#/components/schemas/security-and-analysis" + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - has_discussions + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + - network_count + - subscribers_count + artifact: + title: Artifact + description: An artifact + type: object + properties: + id: + type: integer + examples: + - 5 + node_id: + type: string + examples: + - MDEwOkNoZWNrU3VpdGU1 + name: + description: The name of the artifact. + type: string + examples: + - AdventureWorks.Framework + size_in_bytes: + description: The size in bytes of the artifact. + type: integer + examples: + - 12345 + url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/actions/artifacts/5 + archive_download_url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip + expired: + description: Whether or not the artifact has expired. + type: boolean + created_at: + type: + - string + - 'null' + format: date-time + expires_at: + type: + - string + - 'null' + format: date-time + updated_at: + type: + - string + - 'null' + format: date-time + workflow_run: + type: + - object + - 'null' + properties: + id: + type: integer + examples: + - 10 + repository_id: + type: integer + examples: + - 42 + head_repository_id: + type: integer + examples: + - 42 + head_branch: + type: string + examples: + - main + head_sha: + type: string + examples: + - '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' + required: + - id + - node_id + - name + - size_in_bytes + - url + - archive_download_url + - expired + - created_at + - expires_at + - updated_at + actions-cache-list: + title: Repository actions caches + description: Repository actions caches + type: object + properties: + total_count: + description: Total number of caches + type: integer + examples: + - 2 + actions_caches: + description: Array of caches + type: array + items: + type: object + properties: + id: + type: integer + examples: + - 2 + ref: + type: string + examples: + - refs/heads/main + key: + type: string + examples: + - Linux-node-958aff96db2d75d67787d1e634ae70b659de937b + version: + type: string + examples: + - 73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0 + last_accessed_at: + type: string + format: date-time + examples: + - '2019-01-24T22:45:36.000Z' + created_at: + type: string + format: date-time + examples: + - '2019-01-24T22:45:36.000Z' + size_in_bytes: + type: integer + examples: + - 1024 + required: + - total_count + - actions_caches + job: + title: Job + description: Information of a job execution in a workflow run + type: object + properties: + id: + description: The id of the job. + type: integer + examples: + - 21 + run_id: + description: The id of the associated workflow run. + type: integer + examples: + - 5 + run_url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/actions/runs/5 + run_attempt: + type: integer + description: Attempt number of the associated workflow run, 1 for first + attempt and higher if the workflow was re-run. + examples: + - 1 + node_id: + type: string + examples: + - MDg6Q2hlY2tSdW40 + head_sha: + description: The SHA of the commit that is being run. + type: string + examples: + - '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' + url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/actions/jobs/21 + html_url: + type: + - string + - 'null' + examples: + - https://github.com/github/hello-world/runs/4 + status: + description: The phase of the lifecycle that the job is currently in. + type: string + enum: + - queued + - in_progress + - completed + examples: + - queued + conclusion: + description: The outcome of the job. + type: + - string + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - skipped + - timed_out + - action_required + - + examples: + - success + started_at: + description: The time that the job started, in ISO 8601 format. + format: date-time + type: string + examples: + - '2019-08-08T08:00:00-07:00' + completed_at: + description: The time that the job finished, in ISO 8601 format. + format: date-time + type: + - string + - 'null' + examples: + - '2019-08-08T08:00:00-07:00' + name: + description: The name of the job. + type: string + examples: + - test-coverage + steps: + description: Steps in this job. + type: array + items: + type: object + required: + - name + - status + - conclusion + - number + properties: + status: + description: The phase of the lifecycle that the job is currently + in. + type: string + enum: + - queued + - in_progress + - completed + examples: + - queued + conclusion: + description: The outcome of the job. + type: + - string + - 'null' + examples: + - success + name: + description: The name of the job. + type: string + examples: + - test-coverage + number: + type: integer + examples: + - 1 + started_at: + description: The time that the step started, in ISO 8601 format. + format: date-time + type: + - string + - 'null' + examples: + - '2019-08-08T08:00:00-07:00' + completed_at: + description: The time that the job finished, in ISO 8601 format. + format: date-time + type: + - string + - 'null' + examples: + - '2019-08-08T08:00:00-07:00' + check_run_url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/check-runs/4 + labels: + type: array + items: + type: string + description: Labels for the workflow job. Specified by the "runs_on" attribute + in the action's workflow file. + examples: + - self-hosted + - foo + - bar + runner_id: + type: + - integer + - 'null' + description: The ID of the runner to which this job has been assigned. (If + a runner hasn't yet been assigned, this will be null.) + examples: + - 1 + runner_name: + type: + - string + - 'null' + description: The name of the runner to which this job has been assigned. + (If a runner hasn't yet been assigned, this will be null.) + examples: + - my runner + runner_group_id: + type: + - integer + - 'null' + description: The ID of the runner group to which this job has been assigned. + (If a runner hasn't yet been assigned, this will be null.) + examples: + - 2 + runner_group_name: + type: + - string + - 'null' + description: The name of the runner group to which this job has been assigned. + (If a runner hasn't yet been assigned, this will be null.) + examples: + - my runner group + required: + - id + - node_id + - run_id + - run_url + - head_sha + - name + - url + - html_url + - status + - conclusion + - started_at + - completed_at + - check_run_url + - labels + - runner_id + - runner_name + - runner_group_id + - runner_group_name + actions-enabled: + type: boolean + description: Whether GitHub Actions is enabled on the repository. + actions-repository-permissions: + type: object + properties: + enabled: + "$ref": "#/components/schemas/actions-enabled" + allowed_actions: + "$ref": "#/components/schemas/allowed-actions" + selected_actions_url: + "$ref": "#/components/schemas/selected-actions-url" + required: + - enabled + actions-workflow-access-to-repository: + type: object + properties: + access_level: + type: string + description: |- + Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the + repository. `none` means access is only possible from workflows in this repository. + enum: + - none + - organization + - enterprise + required: + - access_level + referenced-workflow: + title: Referenced workflow + description: A workflow referenced/reused by the initial caller workflow + type: object + properties: + path: + type: string + sha: + type: string + ref: + type: string + required: + - path + - sha + pull-request-minimal: + title: Pull Request Minimal + type: object + properties: + id: + type: integer + number: + type: integer + url: + type: string + head: + type: object + properties: + ref: + type: string + sha: + type: string + repo: + type: object + properties: + id: + type: integer + url: + type: string + name: + type: string + required: + - id + - url + - name + required: + - ref + - sha + - repo + base: + type: object + properties: + ref: + type: string + sha: + type: string + repo: + type: object + properties: + id: + type: integer + url: + type: string + name: + type: string + required: + - id + - url + - name + required: + - ref + - sha + - repo + required: + - id + - number + - url + - head + - base + simple-commit: + title: Simple Commit + description: A commit. + type: object + properties: + id: + type: string + tree_id: + type: string + message: + type: string + timestamp: + type: string + format: date-time + author: + type: + - object + - 'null' + properties: + name: + type: string + email: + type: string + required: + - name + - email + committer: + type: + - object + - 'null' + properties: + name: + type: string + email: + type: string + required: + - name + - email + required: + - id + - tree_id + - message + - timestamp + - author + - committer + workflow-run: + title: Workflow Run + description: An invocation of a workflow + type: object + properties: + id: + type: integer + description: The ID of the workflow run. + examples: + - 5 + name: + type: + - string + - 'null' + description: The name of the workflow run. + examples: + - Build + node_id: + type: string + examples: + - MDEwOkNoZWNrU3VpdGU1 + check_suite_id: + type: integer + description: The ID of the associated check suite. + examples: + - 42 + check_suite_node_id: + type: string + description: The node ID of the associated check suite. + examples: + - MDEwOkNoZWNrU3VpdGU0Mg== + head_branch: + type: + - string + - 'null' + examples: + - master + head_sha: + description: The SHA of the head commit that points to the version of the + workflow being run. + type: string + examples: + - '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' + path: + description: The full path of the workflow + type: string + examples: + - octocat/octo-repo/.github/workflows/ci.yml@main + run_number: + type: integer + description: The auto incrementing run number for the workflow run. + examples: + - 106 + run_attempt: + type: integer + description: Attempt number of the run, 1 for first attempt and higher if + the workflow was re-run. + examples: + - 1 + referenced_workflows: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/referenced-workflow" + event: + type: string + examples: + - push + status: + type: + - string + - 'null' + examples: + - completed + conclusion: + type: + - string + - 'null' + examples: + - neutral + workflow_id: + type: integer + description: The ID of the parent workflow. + examples: + - 5 + url: + type: string + description: The URL to the workflow run. + examples: + - https://api.github.com/repos/github/hello-world/actions/runs/5 + html_url: + type: string + examples: + - https://github.com/github/hello-world/suites/4 + pull_requests: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/pull-request-minimal" + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + actor: + "$ref": "#/components/schemas/simple-user" + triggering_actor: + "$ref": "#/components/schemas/simple-user" + run_started_at: + type: string + format: date-time + description: The start time of the latest run. Resets on re-run. + jobs_url: + description: The URL to the jobs for the workflow run. + type: string + examples: + - https://api.github.com/repos/github/hello-world/actions/runs/5/jobs + logs_url: + description: The URL to download the logs for the workflow run. + type: string + examples: + - https://api.github.com/repos/github/hello-world/actions/runs/5/logs + check_suite_url: + description: The URL to the associated check suite. + type: string + examples: + - https://api.github.com/repos/github/hello-world/check-suites/12 + artifacts_url: + description: The URL to the artifacts for the workflow run. + type: string + examples: + - https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts + cancel_url: + description: The URL to cancel the workflow run. + type: string + examples: + - https://api.github.com/repos/github/hello-world/actions/runs/5/cancel + rerun_url: + description: The URL to rerun the workflow run. + type: string + examples: + - https://api.github.com/repos/github/hello-world/actions/runs/5/rerun + previous_attempt_url: + description: The URL to the previous attempted run of this workflow, if + one exists. + type: + - string + - 'null' + examples: + - https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 + workflow_url: + description: The URL to the workflow. + type: string + examples: + - https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml + head_commit: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-commit" + repository: + "$ref": "#/components/schemas/minimal-repository" + head_repository: + "$ref": "#/components/schemas/minimal-repository" + head_repository_id: + type: integer + examples: + - 5 + display_title: + type: string + description: The event-specific title associated with the run or the run-name + if set, or the value of `run-name` if it is set in the workflow. + examples: + - Simple Workflow + required: + - id + - node_id + - head_branch + - run_number + - display_title + - event + - status + - conclusion + - head_sha + - path + - workflow_id + - url + - html_url + - created_at + - updated_at + - head_commit + - head_repository + - repository + - jobs_url + - logs_url + - check_suite_url + - cancel_url + - rerun_url + - artifacts_url + - workflow_url + - pull_requests + environment-approvals: + title: Environment Approval + description: An entry in the reviews log for environment deployments + type: object + properties: + environments: + description: The list of environments that were approved or rejected + type: array + items: + type: object + properties: + id: + description: The id of the environment. + type: integer + examples: + - 56780428 + node_id: + type: string + examples: + - MDExOkVudmlyb25tZW50NTY3ODA0Mjg= + name: + description: The name of the environment. + type: string + examples: + - staging + url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/environments/staging + html_url: + type: string + examples: + - https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging + created_at: + description: The time that the environment was created, in ISO 8601 + format. + format: date-time + type: string + examples: + - '2020-11-23T22:00:40Z' + updated_at: + description: The time that the environment was last updated, in ISO + 8601 format. + format: date-time + type: string + examples: + - '2020-11-23T22:00:40Z' + state: + description: Whether deployment to the environment(s) was approved or rejected + enum: + - approved + - rejected + type: string + examples: + - approved + user: + "$ref": "#/components/schemas/simple-user" + comment: + type: string + description: The comment submitted with the deployment review + examples: + - Ship it! + required: + - environments + - state + - user + - comment + deployment-reviewer-type: + type: string + description: The type of reviewer. + enum: + - User + - Team + examples: + - User + pending-deployment: + title: Pending Deployment + description: Details of a deployment that is waiting for protection rules to + pass + type: object + properties: + environment: + type: object + properties: + id: + description: The id of the environment. + type: integer + examples: + - 56780428 + node_id: + type: string + examples: + - MDExOkVudmlyb25tZW50NTY3ODA0Mjg= + name: + description: The name of the environment. + type: string + examples: + - staging + url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/environments/staging + html_url: + type: string + examples: + - https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging + wait_timer: + type: integer + description: The set duration of the wait timer + examples: + - 30 + wait_timer_started_at: + description: The time that the wait timer began. + format: date-time + type: + - string + - 'null' + examples: + - '2020-11-23T22:00:40Z' + current_user_can_approve: + description: Whether the currently authenticated user can approve the deployment + type: boolean + examples: + - true + reviewers: + type: array + description: The people or teams that may approve jobs that reference the + environment. You can list up to six users or teams as reviewers. The reviewers + must have at least read access to the repository. Only one of the required + reviewers needs to approve the job for it to proceed. + items: + type: object + properties: + type: + "$ref": "#/components/schemas/deployment-reviewer-type" + reviewer: + anyOf: + - "$ref": "#/components/schemas/simple-user" + - "$ref": "#/components/schemas/team" + required: + - environment + - wait_timer + - wait_timer_started_at + - current_user_can_approve + - reviewers + deployment: + title: Deployment + description: A request for a specific ref(branch,sha,tag) to be deployed + type: object + properties: + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/example/deployments/1 + id: + description: Unique identifier of the deployment + type: integer + examples: + - 42 + node_id: + type: string + examples: + - MDEwOkRlcGxveW1lbnQx + sha: + type: string + examples: + - a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + ref: + description: The ref to deploy. This can be a branch, tag, or sha. + type: string + examples: + - topic-branch + task: + description: Parameter to specify a task to execute + type: string + examples: + - deploy + payload: + oneOf: + - type: object + additionalProperties: true + - type: string + original_environment: + type: string + examples: + - staging + environment: + description: Name for the target deployment environment. + type: string + examples: + - production + description: + type: + - string + - 'null' + examples: + - Deploy request from hubot + creator: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + examples: + - '2012-07-20T01:19:13Z' + updated_at: + type: string + format: date-time + examples: + - '2012-07-20T01:19:13Z' + statuses_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/example/deployments/1/statuses + repository_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/example + transient_environment: + description: 'Specifies if the given environment is will no longer exist + at some point in the future. Default: false.' + type: boolean + examples: + - true + production_environment: + description: 'Specifies if the given environment is one that end-users directly + interact with. Default: false.' + type: boolean + examples: + - true + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + required: + - id + - node_id + - sha + - ref + - task + - environment + - creator + - payload + - description + - statuses_url + - repository_url + - url + - created_at + - updated_at + workflow-run-usage: + title: Workflow Run Usage + description: Workflow Run Usage + type: object + properties: + billable: + type: object + properties: + UBUNTU: + type: object + required: + - total_ms + - jobs + properties: + total_ms: + type: integer + jobs: + type: integer + job_runs: + type: array + items: + type: object + required: + - job_id + - duration_ms + properties: + job_id: + type: integer + duration_ms: + type: integer + MACOS: + type: object + required: + - total_ms + - jobs + properties: + total_ms: + type: integer + jobs: + type: integer + job_runs: + type: array + items: + type: object + required: + - job_id + - duration_ms + properties: + job_id: + type: integer + duration_ms: + type: integer + WINDOWS: + type: object + required: + - total_ms + - jobs + properties: + total_ms: + type: integer + jobs: + type: integer + job_runs: + type: array + items: + type: object + required: + - job_id + - duration_ms + properties: + job_id: + type: integer + duration_ms: + type: integer + run_duration_ms: + type: integer + required: + - billable + actions-secret: + title: Actions Secret + description: Set secrets for GitHub Actions. + type: object + properties: + name: + description: The name of the secret. + type: string + examples: + - SECRET_TOKEN + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - name + - created_at + - updated_at + workflow: + title: Workflow + description: A GitHub Actions workflow + type: object + properties: + id: + type: integer + examples: + - 5 + node_id: + type: string + examples: + - MDg6V29ya2Zsb3cxMg== + name: + type: string + examples: + - CI + path: + type: string + examples: + - ruby.yaml + state: + type: string + enum: + - active + - deleted + - disabled_fork + - disabled_inactivity + - disabled_manually + examples: + - active + created_at: + type: string + format: date-time + examples: + - '2019-12-06T14:20:20.000Z' + updated_at: + type: string + format: date-time + examples: + - '2019-12-06T14:20:20.000Z' + url: + type: string + examples: + - https://api.github.com/repos/actions/setup-ruby/workflows/5 + html_url: + type: string + examples: + - https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml + badge_url: + type: string + examples: + - https://github.com/actions/setup-ruby/workflows/CI/badge.svg + deleted_at: + type: string + format: date-time + examples: + - '2019-12-06T14:20:20.000Z' + required: + - id + - node_id + - name + - path + - state + - url + - html_url + - badge_url + - created_at + - updated_at + workflow-usage: + title: Workflow Usage + description: Workflow Usage + type: object + properties: + billable: + type: object + properties: + UBUNTU: + type: object + properties: + total_ms: + type: integer + MACOS: + type: object + properties: + total_ms: + type: integer + WINDOWS: + type: object + properties: + total_ms: + type: integer + required: + - billable + autolink: + title: Autolink reference + description: An autolink reference. + type: object + properties: + id: + type: integer + examples: + - 3 + key_prefix: + description: The prefix of a key that is linkified. + type: string + examples: + - TICKET- + url_template: + description: A template for the target URL that is generated if a key was + found. + type: string + examples: + - https://example.com/TICKET?query=comment body
"' + body_text: + type: string + examples: + - '"comment body"' + required: + - url + - id + - node_id + - pull_request_review_id + - diff_hunk + - path + - position + - original_position + - commit_id + - original_commit_id + - user + - body + - created_at + - updated_at + - html_url + - pull_request_url + - author_association + - _links + timeline-line-commented-event: + title: Timeline Line Commented Event + description: Timeline Line Commented Event + type: object + properties: + event: + type: string + node_id: + type: string + comments: + type: array + items: + "$ref": "#/components/schemas/pull-request-review-comment" + timeline-commit-commented-event: + title: Timeline Commit Commented Event + description: Timeline Commit Commented Event + type: object + properties: + event: + type: string + node_id: + type: string + commit_id: + type: string + comments: + type: array + items: + "$ref": "#/components/schemas/commit-comment" + timeline-assigned-issue-event: + title: Timeline Assigned Issue Event + description: Timeline Assigned Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + "$ref": "#/components/schemas/simple-user" + event: + type: string + commit_id: + type: + - string + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + assignee: + "$ref": "#/components/schemas/simple-user" + required: + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + - assignee + timeline-unassigned-issue-event: + title: Timeline Unassigned Issue Event + description: Timeline Unassigned Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + "$ref": "#/components/schemas/simple-user" + event: + type: string + commit_id: + type: + - string + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + assignee: + "$ref": "#/components/schemas/simple-user" + required: + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + - assignee + state-change-issue-event: + title: State Change Issue Event + description: State Change Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + "$ref": "#/components/schemas/simple-user" + event: + type: string + commit_id: + type: + - string + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + state_reason: + type: + - string + - 'null' + required: + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + timeline-issue-events: + title: Timeline Event + description: Timeline Event + type: object + anyOf: + - "$ref": "#/components/schemas/labeled-issue-event" + - "$ref": "#/components/schemas/unlabeled-issue-event" + - "$ref": "#/components/schemas/milestoned-issue-event" + - "$ref": "#/components/schemas/demilestoned-issue-event" + - "$ref": "#/components/schemas/renamed-issue-event" + - "$ref": "#/components/schemas/review-requested-issue-event" + - "$ref": "#/components/schemas/review-request-removed-issue-event" + - "$ref": "#/components/schemas/review-dismissed-issue-event" + - "$ref": "#/components/schemas/locked-issue-event" + - "$ref": "#/components/schemas/added-to-project-issue-event" + - "$ref": "#/components/schemas/moved-column-in-project-issue-event" + - "$ref": "#/components/schemas/removed-from-project-issue-event" + - "$ref": "#/components/schemas/converted-note-to-issue-issue-event" + - "$ref": "#/components/schemas/timeline-comment-event" + - "$ref": "#/components/schemas/timeline-cross-referenced-event" + - "$ref": "#/components/schemas/timeline-committed-event" + - "$ref": "#/components/schemas/timeline-reviewed-event" + - "$ref": "#/components/schemas/timeline-line-commented-event" + - "$ref": "#/components/schemas/timeline-commit-commented-event" + - "$ref": "#/components/schemas/timeline-assigned-issue-event" + - "$ref": "#/components/schemas/timeline-unassigned-issue-event" + - "$ref": "#/components/schemas/state-change-issue-event" + deploy-key: + title: Deploy Key + description: An SSH key granting access to a single repository. + type: object + properties: + id: + type: integer + key: + type: string + url: + type: string + title: + type: string + verified: + type: boolean + created_at: + type: string + read_only: + type: boolean + added_by: + type: + - string + - 'null' + last_used: + type: + - string + - 'null' + required: + - id + - key + - url + - title + - verified + - created_at + - read_only + language: + title: Language + description: Language + type: object + additionalProperties: + type: integer + license-content: + title: License Content + description: License Content + type: object + properties: + name: + type: string + path: + type: string + sha: + type: string + size: + type: integer + url: + type: string + format: uri + html_url: + type: + - string + - 'null' + format: uri + git_url: + type: + - string + - 'null' + format: uri + download_url: + type: + - string + - 'null' + format: uri + type: + type: string + content: + type: string + encoding: + type: string + _links: + type: object + properties: + git: + type: + - string + - 'null' + format: uri + html: + type: + - string + - 'null' + format: uri + self: + type: string + format: uri + required: + - git + - html + - self + license: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/license-simple" + required: + - _links + - git_url + - html_url + - download_url + - name + - path + - sha + - size + - type + - url + - content + - encoding + - license + merged-upstream: + title: Merged upstream + description: Results of a successful merge upstream request + type: object + properties: + message: + type: string + merge_type: + type: string + enum: + - merge + - fast-forward + - none + base_branch: + type: string + pages-source-hash: + title: Pages Source Hash + type: object + properties: + branch: + type: string + path: + type: string + required: + - branch + - path + pages-https-certificate: + title: Pages Https Certificate + type: object + properties: + state: + type: string + enum: + - new + - authorization_created + - authorization_pending + - authorized + - authorization_revoked + - issued + - uploaded + - approved + - errored + - bad_authz + - destroy_pending + - dns_changed + examples: + - approved + description: + type: string + examples: + - Certificate is approved + domains: + type: array + items: + type: string + description: Array of the domain set and its alternate name (if it is configured) + examples: + - example.com + - www.example.com + expires_at: + type: string + format: date + required: + - state + - description + - domains + page: + title: GitHub Pages + description: The configuration for GitHub Pages for a repository. + type: object + properties: + url: + type: string + description: The API address for accessing this Page resource. + format: uri + examples: + - https://api.github.com/repos/github/hello-world/pages + status: + type: + - string + - 'null' + description: The status of the most recent build of the Page. + enum: + - built + - building + - errored + - + examples: + - built + cname: + description: The Pages site's custom domain + type: + - string + - 'null' + examples: + - example.com + protected_domain_state: + type: + - string + - 'null' + description: The state if the domain is verified + enum: + - pending + - verified + - unverified + - + examples: + - pending + pending_domain_unverified_at: + type: + - string + - 'null' + description: The timestamp when a pending domain becomes unverified. + format: date-time + custom_404: + type: boolean + description: Whether the Page has a custom 404 page. + default: false + examples: + - false + html_url: + type: string + description: The web address the Page can be accessed from. + format: uri + examples: + - https://example.com + build_type: + type: + - string + - 'null' + description: The process in which the Page will be built. + enum: + - legacy + - workflow + - + examples: + - legacy + source: + "$ref": "#/components/schemas/pages-source-hash" + public: + type: boolean + description: Whether the GitHub Pages site is publicly visible. If set to + `true`, the site is accessible to anyone on the internet. If set to `false`, + the site will only be accessible to users who have at least `read` access + to the repository that published the site. + examples: + - true + https_certificate: + "$ref": "#/components/schemas/pages-https-certificate" + https_enforced: + type: boolean + description: Whether https is enabled on the domain + examples: + - true + required: + - url + - status + - cname + - custom_404 + - public + page-build: + title: Page Build + description: Page Build + type: object + properties: + url: + type: string + format: uri + status: + type: string + error: + type: object + properties: + message: + type: + - string + - 'null' + required: + - message + pusher: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + commit: + type: string + duration: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - url + - status + - error + - pusher + - commit + - duration + - created_at + - updated_at + page-build-status: + title: Page Build Status + description: Page Build Status + type: object + properties: + url: + type: string + format: uri + examples: + - https://api.github.com/repos/github/hello-world/pages/builds/latest + status: + type: string + examples: + - queued + required: + - url + - status + page-deployment: + title: GitHub Pages + description: The GitHub Pages deployment status. + type: object + properties: + status_url: + type: string + description: The URI to monitor GitHub Pages deployment status. + format: uri + examples: + - https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status + page_url: + type: string + description: The URI to the deployed GitHub Pages. + format: uri + examples: + - hello-world.github.io + preview_url: + type: string + description: The URI to the deployed GitHub Pages preview. + format: uri + examples: + - monalisa-1231a2312sa32-23sda74.drafts.github.io + required: + - status_url + - page_url + pages-health-check: + title: Pages Health Check Status + description: Pages Health Check Status + type: object + properties: + domain: + type: object + properties: + host: + type: string + uri: + type: string + nameservers: + type: string + dns_resolves: + type: boolean + is_proxied: + type: + - boolean + - 'null' + is_cloudflare_ip: + type: + - boolean + - 'null' + is_fastly_ip: + type: + - boolean + - 'null' + is_old_ip_address: + type: + - boolean + - 'null' + is_a_record: + type: + - boolean + - 'null' + has_cname_record: + type: + - boolean + - 'null' + has_mx_records_present: + type: + - boolean + - 'null' + is_valid_domain: + type: boolean + is_apex_domain: + type: boolean + should_be_a_record: + type: + - boolean + - 'null' + is_cname_to_github_user_domain: + type: + - boolean + - 'null' + is_cname_to_pages_dot_github_dot_com: + type: + - boolean + - 'null' + is_cname_to_fastly: + type: + - boolean + - 'null' + is_pointed_to_github_pages_ip: + type: + - boolean + - 'null' + is_non_github_pages_ip_present: + type: + - boolean + - 'null' + is_pages_domain: + type: boolean + is_served_by_pages: + type: + - boolean + - 'null' + is_valid: + type: boolean + reason: + type: + - string + - 'null' + responds_to_https: + type: boolean + enforces_https: + type: boolean + https_error: + type: + - string + - 'null' + is_https_eligible: + type: + - boolean + - 'null' + caa_error: + type: + - string + - 'null' + alt_domain: + type: + - object + - 'null' + properties: + host: + type: string + uri: + type: string + nameservers: + type: string + dns_resolves: + type: boolean + is_proxied: + type: + - boolean + - 'null' + is_cloudflare_ip: + type: + - boolean + - 'null' + is_fastly_ip: + type: + - boolean + - 'null' + is_old_ip_address: + type: + - boolean + - 'null' + is_a_record: + type: + - boolean + - 'null' + has_cname_record: + type: + - boolean + - 'null' + has_mx_records_present: + type: + - boolean + - 'null' + is_valid_domain: + type: boolean + is_apex_domain: + type: boolean + should_be_a_record: + type: + - boolean + - 'null' + is_cname_to_github_user_domain: + type: + - boolean + - 'null' + is_cname_to_pages_dot_github_dot_com: + type: + - boolean + - 'null' + is_cname_to_fastly: + type: + - boolean + - 'null' + is_pointed_to_github_pages_ip: + type: + - boolean + - 'null' + is_non_github_pages_ip_present: + type: + - boolean + - 'null' + is_pages_domain: + type: boolean + is_served_by_pages: + type: + - boolean + - 'null' + is_valid: + type: boolean + reason: + type: + - string + - 'null' + responds_to_https: + type: boolean + enforces_https: + type: boolean + https_error: + type: + - string + - 'null' + is_https_eligible: + type: + - boolean + - 'null' + caa_error: + type: + - string + - 'null' + pull-request: + type: object + title: Pull Request + description: Pull requests let you tell others about changes you've pushed to + a repository on GitHub. Once a pull request is sent, interested parties can + review the set of changes, discuss potential modifications, and even push + follow-up commits if necessary. + properties: + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/1347 + id: + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDExOlB1bGxSZXF1ZXN0MQ== + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/1347 + diff_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: + type: string + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + comments_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + statuses_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + number: + description: Number uniquely identifying the pull request within its repository. + type: integer + examples: + - 42 + state: + description: State of this Pull Request. Either `open` or `closed`. + enum: + - open + - closed + type: string + examples: + - open + locked: + type: boolean + examples: + - true + title: + description: The title of the pull request. + type: string + examples: + - Amazing new feature + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + body: + type: + - string + - 'null' + examples: + - Please pull these awesome changes + labels: + type: array + items: + type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + type: string + name: + type: string + description: + type: + - string + - 'null' + color: + type: string + default: + type: boolean + required: + - id + - node_id + - url + - name + - description + - color + - default + milestone: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/milestone" + active_lock_reason: + type: + - string + - 'null' + examples: + - too heated + created_at: + type: string + format: date-time + examples: + - '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + examples: + - '2011-01-26T19:01:12Z' + closed_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:01:12Z' + merged_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:01:12Z' + merge_commit_sha: + type: + - string + - 'null' + examples: + - e5bd3914e2e596debea16f433f57875b5b90bcd6 + assignee: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + assignees: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/simple-user" + requested_reviewers: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/simple-user" + requested_teams: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/team-simple" + head: + type: object + properties: + label: + type: string + ref: + type: string + repo: + type: + - object + - 'null' + properties: + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + format: uri + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + node_id: + type: string + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + format: uri + merges_url: + type: string + format: uri + milestones_url: + type: string + name: + type: string + notifications_url: + type: string + owner: + type: object + properties: + avatar_url: + type: string + format: uri + events_url: + type: string + followers_url: + type: string + format: uri + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + type: integer + node_id: + type: string + login: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + format: uri + type: + type: string + url: + type: string + format: uri + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + format: uri + statuses_url: + type: string + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + trees_url: + type: string + url: + type: string + format: uri + clone_url: + type: string + default_branch: + type: string + forks: + type: integer + forks_count: + type: integer + git_url: + type: string + has_downloads: + type: boolean + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_discussions: + type: boolean + homepage: + type: + - string + - 'null' + format: uri + language: + type: + - string + - 'null' + master_branch: + type: string + archived: + type: boolean + disabled: + type: boolean + visibility: + description: 'The repository visibility: public, private, or internal.' + type: string + mirror_url: + type: + - string + - 'null' + format: uri + open_issues: + type: integer + open_issues_count: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + required: + - admin + - pull + - push + temp_clone_token: + type: string + allow_merge_commit: + type: boolean + allow_squash_merge: + type: boolean + allow_rebase_merge: + type: boolean + license: + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + url: + type: + - string + - 'null' + format: uri + spdx_id: + type: + - string + - 'null' + node_id: + type: string + required: + - key + - name + - url + - spdx_id + - node_id + pushed_at: + type: string + format: date-time + size: + type: integer + ssh_url: + type: string + stargazers_count: + type: integer + svn_url: + type: string + format: uri + topics: + type: array + items: + type: string + watchers: + type: integer + watchers_count: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + allow_forking: + type: boolean + is_template: + type: boolean + web_commit_signoff_required: + type: boolean + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - has_discussions + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + sha: + type: string + user: + type: object + properties: + avatar_url: + type: string + format: uri + events_url: + type: string + followers_url: + type: string + format: uri + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + type: integer + node_id: + type: string + login: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + format: uri + type: + type: string + url: + type: string + format: uri + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + required: + - label + - ref + - repo + - sha + - user + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + type: object + properties: + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + format: uri + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + is_template: + type: boolean + node_id: + type: string + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + format: uri + merges_url: + type: string + format: uri + milestones_url: + type: string + name: + type: string + notifications_url: + type: string + owner: + type: object + properties: + avatar_url: + type: string + format: uri + events_url: + type: string + followers_url: + type: string + format: uri + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + type: integer + node_id: + type: string + login: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + format: uri + type: + type: string + url: + type: string + format: uri + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + format: uri + statuses_url: + type: string + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + trees_url: + type: string + url: + type: string + format: uri + clone_url: + type: string + default_branch: + type: string + forks: + type: integer + forks_count: + type: integer + git_url: + type: string + has_downloads: + type: boolean + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_discussions: + type: boolean + homepage: + type: + - string + - 'null' + format: uri + language: + type: + - string + - 'null' + master_branch: + type: string + archived: + type: boolean + disabled: + type: boolean + visibility: + description: 'The repository visibility: public, private, or internal.' + type: string + mirror_url: + type: + - string + - 'null' + format: uri + open_issues: + type: integer + open_issues_count: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + required: + - admin + - pull + - push + temp_clone_token: + type: string + allow_merge_commit: + type: boolean + allow_squash_merge: + type: boolean + allow_rebase_merge: + type: boolean + license: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/license-simple" + pushed_at: + type: string + format: date-time + size: + type: integer + ssh_url: + type: string + stargazers_count: + type: integer + svn_url: + type: string + format: uri + topics: + type: array + items: + type: string + watchers: + type: integer + watchers_count: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + allow_forking: + type: boolean + web_commit_signoff_required: + type: boolean + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - has_discussions + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + sha: + type: string + user: + type: object + properties: + avatar_url: + type: string + format: uri + events_url: + type: string + followers_url: + type: string + format: uri + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + type: integer + node_id: + type: string + login: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + format: uri + type: + type: string + url: + type: string + format: uri + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + required: + - label + - ref + - repo + - sha + - user + _links: + type: object + properties: + comments: + "$ref": "#/components/schemas/link" + commits: + "$ref": "#/components/schemas/link" + statuses: + "$ref": "#/components/schemas/link" + html: + "$ref": "#/components/schemas/link" + issue: + "$ref": "#/components/schemas/link" + review_comments: + "$ref": "#/components/schemas/link" + review_comment: + "$ref": "#/components/schemas/link" + self: + "$ref": "#/components/schemas/link" + required: + - comments + - commits + - statuses + - html + - issue + - review_comments + - review_comment + - self + author_association: + "$ref": "#/components/schemas/author-association" + auto_merge: + "$ref": "#/components/schemas/auto-merge" + draft: + description: Indicates whether or not the pull request is a draft. + type: boolean + examples: + - false + merged: + type: boolean + mergeable: + type: + - boolean + - 'null' + examples: + - true + rebaseable: + type: + - boolean + - 'null' + examples: + - true + mergeable_state: + type: string + examples: + - clean + merged_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + comments: + type: integer + examples: + - 10 + review_comments: + type: integer + examples: + - 0 + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull request. + type: boolean + examples: + - true + commits: + type: integer + examples: + - 3 + additions: + type: integer + examples: + - 100 + deletions: + type: integer + examples: + - 3 + changed_files: + type: integer + examples: + - 5 + required: + - _links + - assignee + - labels + - base + - body + - closed_at + - comments_url + - commits_url + - created_at + - diff_url + - head + - html_url + - id + - node_id + - issue_url + - merge_commit_sha + - merged_at + - milestone + - number + - patch_url + - review_comment_url + - review_comments_url + - statuses_url + - state + - locked + - title + - updated_at + - url + - user + - author_association + - auto_merge + - additions + - changed_files + - comments + - commits + - deletions + - mergeable + - mergeable_state + - merged + - maintainer_can_modify + - merged_by + - review_comments + pull-request-merge-result: + title: Pull Request Merge Result + description: Pull Request Merge Result + type: object + properties: + sha: + type: string + merged: + type: boolean + message: + type: string + required: + - merged + - message + - sha + pull-request-review-request: + title: Pull Request Review Request + description: Pull Request Review Request + type: object + properties: + users: + type: array + items: + "$ref": "#/components/schemas/simple-user" + teams: + type: array + items: + "$ref": "#/components/schemas/team" + required: + - users + - teams + pull-request-review: + title: Pull Request Review + description: Pull Request Reviews are reviews on pull requests. + type: object + properties: + id: + description: Unique identifier of the review + type: integer + examples: + - 42 + node_id: + type: string + examples: + - MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + body: + description: The text of the review. + type: string + examples: + - This looks great. + state: + type: string + examples: + - CHANGES_REQUESTED + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/12 + _links: + type: object + properties: + html: + type: object + properties: + href: + type: string + required: + - href + pull_request: + type: object + properties: + href: + type: string + required: + - href + required: + - html + - pull_request + submitted_at: + type: string + format: date-time + commit_id: + description: A commit SHA for the review. + type: string + examples: + - 54bb654c9e6025347f57900a4a5c2313a96b8035 + body_html: + type: string + body_text: + type: string + author_association: + "$ref": "#/components/schemas/author-association" + required: + - id + - node_id + - user + - body + - state + - commit_id + - html_url + - pull_request_url + - _links + - author_association + review-comment: + title: Legacy Review Comment + description: Legacy Review Comment + type: object + properties: + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + pull_request_review_id: + type: + - integer + - 'null' + examples: + - 42 + id: + type: integer + examples: + - 10 + node_id: + type: string + examples: + - MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw + diff_hunk: + type: string + examples: + - "@@ -16,33 +16,40 @@ public class Connection : IConnection..." + path: + type: string + examples: + - file1.txt + position: + type: + - integer + - 'null' + examples: + - 1 + original_position: + type: integer + examples: + - 4 + commit_id: + type: string + examples: + - 6dcb09b5b57875f334f61aebed695e2e4193db5e + original_commit_id: + type: string + examples: + - 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 + in_reply_to_id: + type: integer + examples: + - 8 + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + body: + type: string + examples: + - Great stuff + created_at: + type: string + format: date-time + examples: + - '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + examples: + - '2011-04-14T16:00:49Z' + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + pull_request_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/1 + author_association: + "$ref": "#/components/schemas/author-association" + _links: + type: object + properties: + self: + "$ref": "#/components/schemas/link" + html: + "$ref": "#/components/schemas/link" + pull_request: + "$ref": "#/components/schemas/link" + required: + - self + - html + - pull_request + body_text: + type: string + body_html: + type: string + reactions: + "$ref": "#/components/schemas/reaction-rollup" + side: + description: The side of the first line of the range for a multi-line comment. + enum: + - LEFT + - RIGHT + default: RIGHT + type: string + start_side: + type: + - string + - 'null' + description: The side of the first line of the range for a multi-line comment. + enum: + - LEFT + - RIGHT + - + default: RIGHT + line: + description: The line of the blob to which the comment applies. The last + line of the range for a multi-line comment + type: integer + examples: + - 2 + original_line: + description: The original line of the blob to which the comment applies. + The last line of the range for a multi-line comment + type: integer + examples: + - 2 + start_line: + description: The first line of the range for a multi-line comment. + type: + - integer + - 'null' + examples: + - 2 + original_start_line: + description: The original first line of the range for a multi-line comment. + type: + - integer + - 'null' + examples: + - 2 + required: + - id + - node_id + - url + - body + - diff_hunk + - path + - position + - original_position + - commit_id + - original_commit_id + - user + - pull_request_review_id + - html_url + - pull_request_url + - _links + - author_association + - created_at + - updated_at + release-asset: + title: Release Asset + description: Data related to a release. + type: object + properties: + url: + type: string + format: uri + browser_download_url: + type: string + format: uri + id: + type: integer + node_id: + type: string + name: + description: The file name of the asset. + type: string + examples: + - Team Environment + label: + type: + - string + - 'null' + state: + description: State of the release asset. + type: string + enum: + - uploaded + - open + content_type: + type: string + size: + type: integer + download_count: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + uploader: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + required: + - id + - name + - content_type + - size + - state + - url + - node_id + - download_count + - label + - uploader + - browser_download_url + - created_at + - updated_at + release: + title: Release + description: A release. + type: object + properties: + url: + type: string + format: uri + html_url: + type: string + format: uri + assets_url: + type: string + format: uri + upload_url: + type: string + tarball_url: + type: + - string + - 'null' + format: uri + zipball_url: + type: + - string + - 'null' + format: uri + id: + type: integer + node_id: + type: string + tag_name: + description: The name of the tag. + type: string + examples: + - v1.0.0 + target_commitish: + description: Specifies the commitish value that determines where the Git + tag is created from. + type: string + examples: + - master + name: + type: + - string + - 'null' + body: + type: + - string + - 'null' + draft: + description: true to create a draft (unpublished) release, false to create + a published one. + type: boolean + examples: + - false + prerelease: + description: Whether to identify the release as a prerelease or a full release. + type: boolean + examples: + - false + created_at: + type: string + format: date-time + published_at: + type: + - string + - 'null' + format: date-time + author: + "$ref": "#/components/schemas/simple-user" + assets: + type: array + items: + "$ref": "#/components/schemas/release-asset" + body_html: + type: string + body_text: + type: string + mentions_count: + type: integer + discussion_url: + description: The URL of the release discussion. + type: string + format: uri + reactions: + "$ref": "#/components/schemas/reaction-rollup" + required: + - assets_url + - upload_url + - tarball_url + - zipball_url + - created_at + - published_at + - draft + - id + - node_id + - author + - html_url + - name + - prerelease + - tag_name + - target_commitish + - assets + - url + release-notes-content: + title: Generated Release Notes Content + description: Generated name and body describing a release + type: object + properties: + name: + description: The generated name of the release + type: string + examples: + - Release v1.0.0 is now available! + body: + description: The generated body describing the contents of the release supporting + markdown formatting + type: string + required: + - name + - body + secret-scanning-alert: + type: object + properties: + number: + "$ref": "#/components/schemas/alert-number" + created_at: + "$ref": "#/components/schemas/alert-created-at" + updated_at: + "$ref": "#/components/schemas/alert-updated-at" + url: + "$ref": "#/components/schemas/alert-url" + html_url: + "$ref": "#/components/schemas/alert-html-url" + locations_url: + type: string + format: uri + description: The REST API URL of the code locations for this alert. + state: + "$ref": "#/components/schemas/secret-scanning-alert-state" + resolution: + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + resolved_at: + type: + - string + - 'null' + format: date-time + description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + resolved_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + resolution_comment: + type: + - string + - 'null' + description: An optional comment to resolve an alert. + secret_type: + type: string + description: The type of secret that secret scanning detected. + secret_type_display_name: + type: string + description: |- + User-friendly name for the detected secret, matching the `secret_type`. + For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." + secret: + type: string + description: The secret that was detected. + push_protection_bypassed: + type: + - boolean + - 'null' + description: Whether push protection was bypassed for the detected secret. + push_protection_bypassed_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + push_protection_bypassed_at: + type: + - string + - 'null' + format: date-time + description: 'The time that push protection was bypassed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + secret-scanning-alert-resolution-comment: + description: An optional comment when closing an alert. Cannot be updated or + deleted. Must be `null` when changing `state` to `open`. + type: + - string + - 'null' + secret-scanning-location-commit: + description: Represents a 'commit' secret scanning location type. This location + type shows that a secret was detected inside a commit to a repository. + type: object + properties: + path: + type: string + description: The file path in the repository + examples: + - "/example/secrets.txt" + start_line: + type: number + description: Line number at which the secret starts in the file + end_line: + type: number + description: Line number at which the secret ends in the file + start_column: + type: number + description: The column at which the secret starts within the start line + when the file is interpreted as 8BIT ASCII + end_column: + type: number + description: The column at which the secret ends within the end line when + the file is interpreted as 8BIT ASCII + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + examples: + - af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: + type: string + description: The API URL to get the associated blob resource + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + examples: + - af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_url: + type: string + description: The API URL to get the associated commit resource + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - blob_url + - commit_sha + - commit_url + secret-scanning-location: + type: object + properties: + type: + type: string + enum: + - commit + description: The location type. Because secrets may be found in different + types of resources (ie. code, comments, issues), this field identifies + the type of resource where the secret was found. + examples: + - commit + details: + oneOf: + - "$ref": "#/components/schemas/secret-scanning-location-commit" + required: + - type + - details + stargazer: + title: Stargazer + description: Stargazer + type: object + properties: + starred_at: + type: string + format: date-time + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + required: + - starred_at + - user + code-frequency-stat: + title: Code Frequency Stat + description: Code Frequency Stat + type: array + items: + type: integer + commit-activity: + title: Commit Activity + description: Commit Activity + type: object + properties: + days: + type: array + items: + type: integer + examples: + - 0 + - 3 + - 26 + - 20 + - 39 + - 1 + - 0 + total: + type: integer + examples: + - 89 + week: + type: integer + examples: + - 1336280400 + required: + - days + - total + - week + contributor-activity: + title: Contributor Activity + description: Contributor Activity + type: object + properties: + author: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + total: + type: integer + examples: + - 135 + weeks: + type: array + items: + type: object + properties: + w: + type: integer + a: + type: integer + d: + type: integer + c: + type: integer + examples: + - w: '1367712000' + a: 6898 + d: 77 + c: 10 + required: + - author + - total + - weeks + participation-stats: + title: Participation Stats + type: object + properties: + all: + type: array + items: + type: integer + owner: + type: array + items: + type: integer + required: + - all + - owner + repository-subscription: + title: Repository Invitation + description: Repository invitations let you manage who you collaborate with. + type: object + properties: + subscribed: + description: Determines if notifications should be received from this repository. + type: boolean + examples: + - true + ignored: + description: Determines if all notifications should be blocked from this + repository. + type: boolean + reason: + type: + - string + - 'null' + created_at: + type: string + format: date-time + examples: + - '2012-10-06T21:34:12Z' + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/example/subscription + repository_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/example + required: + - created_at + - ignored + - reason + - subscribed + - url + - repository_url + tag: + title: Tag + description: Tag + type: object + properties: + name: + type: string + examples: + - v0.1 + commit: + type: object + properties: + sha: + type: string + url: + type: string + format: uri + required: + - sha + - url + zipball_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/zipball/v0.1 + tarball_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/tarball/v0.1 + node_id: + type: string + required: + - name + - node_id + - commit + - zipball_url + - tarball_url + tag-protection: + title: Tag protection + description: Tag protection + type: object + properties: + id: + type: integer + examples: + - 2 + created_at: + type: string + examples: + - '2011-01-26T19:01:12Z' + updated_at: + type: string + examples: + - '2011-01-26T19:01:12Z' + enabled: + type: boolean + examples: + - true + pattern: + type: string + examples: + - v1.* + required: + - pattern + topic: + title: Topic + description: A topic aggregates entities that are related to a subject. + type: object + properties: + names: + type: array + items: + type: string + required: + - names + traffic: + title: Traffic + type: object + properties: + timestamp: + type: string + format: date-time + uniques: + type: integer + count: + type: integer + required: + - timestamp + - uniques + - count + clone-traffic: + title: Clone Traffic + description: Clone Traffic + type: object + properties: + count: + type: integer + examples: + - 173 + uniques: + type: integer + examples: + - 128 + clones: + type: array + items: + "$ref": "#/components/schemas/traffic" + required: + - uniques + - count + - clones + content-traffic: + title: Content Traffic + description: Content Traffic + type: object + properties: + path: + type: string + examples: + - "/github/hubot" + title: + type: string + examples: + - 'github/hubot: A customizable life embetterment robot.' + count: + type: integer + examples: + - 3542 + uniques: + type: integer + examples: + - 2225 + required: + - path + - title + - uniques + - count + referrer-traffic: + title: Referrer Traffic + description: Referrer Traffic + type: object + properties: + referrer: + type: string + examples: + - Google + count: + type: integer + examples: + - 4 + uniques: + type: integer + examples: + - 3 + required: + - referrer + - uniques + - count + view-traffic: + title: View Traffic + description: View Traffic + type: object + properties: + count: + type: integer + examples: + - 14850 + uniques: + type: integer + examples: + - 3782 + views: + type: array + items: + "$ref": "#/components/schemas/traffic" + required: + - uniques + - count + - views + search-result-text-matches: + title: Search Result Text Matches + type: array + items: + type: object + properties: + object_url: + type: string + object_type: + type: + - string + - 'null' + property: + type: string + fragment: + type: string + matches: + type: array + items: + type: object + properties: + text: + type: string + indices: + type: array + items: + type: integer + code-search-result-item: + title: Code Search Result Item + description: Code Search Result Item + type: object + properties: + name: + type: string + path: + type: string + sha: + type: string + url: + type: string + format: uri + git_url: + type: string + format: uri + html_url: + type: string + format: uri + repository: + "$ref": "#/components/schemas/minimal-repository" + score: + type: number + file_size: + type: integer + language: + type: + - string + - 'null' + last_modified_at: + type: string + format: date-time + line_numbers: + type: array + items: + type: string + examples: + - 73..77 + - 77..78 + text_matches: + "$ref": "#/components/schemas/search-result-text-matches" + required: + - score + - name + - path + - sha + - git_url + - html_url + - url + - repository + commit-search-result-item: + title: Commit Search Result Item + description: Commit Search Result Item + type: object + properties: + url: + type: string + format: uri + sha: + type: string + html_url: + type: string + format: uri + comments_url: + type: string + format: uri + commit: + type: object + properties: + author: + type: object + properties: + name: + type: string + email: + type: string + date: + type: string + format: date-time + required: + - name + - email + - date + committer: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/git-user" + comment_count: + type: integer + message: + type: string + tree: + type: object + properties: + sha: + type: string + url: + type: string + format: uri + required: + - sha + - url + url: + type: string + format: uri + verification: + "$ref": "#/components/schemas/verification" + required: + - author + - committer + - comment_count + - message + - tree + - url + author: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + committer: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/git-user" + parents: + type: array + items: + type: object + properties: + url: + type: string + html_url: + type: string + sha: + type: string + repository: + "$ref": "#/components/schemas/minimal-repository" + score: + type: number + node_id: + type: string + text_matches: + "$ref": "#/components/schemas/search-result-text-matches" + required: + - sha + - node_id + - url + - html_url + - author + - committer + - parents + - comments_url + - commit + - repository + - score + issue-search-result-item: + title: Issue Search Result Item + description: Issue Search Result Item + type: object + properties: + url: + type: string + format: uri + repository_url: + type: string + format: uri + labels_url: + type: string + comments_url: + type: string + format: uri + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + node_id: + type: string + number: + type: integer + title: + type: string + locked: + type: boolean + active_lock_reason: + type: + - string + - 'null' + assignees: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/simple-user" + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + labels: + type: array + items: + type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + type: string + name: + type: string + color: + type: string + default: + type: boolean + description: + type: + - string + - 'null' + state: + type: string + state_reason: + type: + - string + - 'null' + assignee: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + milestone: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/milestone" + comments: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + closed_at: + type: + - string + - 'null' + format: date-time + text_matches: + "$ref": "#/components/schemas/search-result-text-matches" + pull_request: + type: object + properties: + merged_at: + type: + - string + - 'null' + format: date-time + diff_url: + type: + - string + - 'null' + format: uri + html_url: + type: + - string + - 'null' + format: uri + patch_url: + type: + - string + - 'null' + format: uri + url: + type: + - string + - 'null' + format: uri + required: + - diff_url + - html_url + - patch_url + - url + body: + type: string + score: + type: number + author_association: + "$ref": "#/components/schemas/author-association" + draft: + type: boolean + repository: + "$ref": "#/components/schemas/repository" + body_html: + type: string + body_text: + type: string + timeline_url: + type: string + format: uri + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + reactions: + "$ref": "#/components/schemas/reaction-rollup" + required: + - assignee + - closed_at + - comments + - comments_url + - events_url + - html_url + - id + - node_id + - labels + - labels_url + - milestone + - number + - repository_url + - state + - locked + - title + - url + - user + - author_association + - created_at + - updated_at + - score + label-search-result-item: + title: Label Search Result Item + description: Label Search Result Item + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + format: uri + name: + type: string + color: + type: string + default: + type: boolean + description: + type: + - string + - 'null' + score: + type: number + text_matches: + "$ref": "#/components/schemas/search-result-text-matches" + required: + - id + - node_id + - url + - name + - color + - default + - description + - score + repo-search-result-item: + title: Repo Search Result Item + description: Repo Search Result Item + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + full_name: + type: string + owner: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + private: + type: boolean + html_url: + type: string + format: uri + description: + type: + - string + - 'null' + fork: + type: boolean + url: + type: string + format: uri + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + pushed_at: + type: string + format: date-time + homepage: + type: + - string + - 'null' + format: uri + size: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + language: + type: + - string + - 'null' + forks_count: + type: integer + open_issues_count: + type: integer + master_branch: + type: string + default_branch: + type: string + score: + type: number + forks_url: + type: string + format: uri + keys_url: + type: string + collaborators_url: + type: string + teams_url: + type: string + format: uri + hooks_url: + type: string + format: uri + issue_events_url: + type: string + events_url: + type: string + format: uri + assignees_url: + type: string + branches_url: + type: string + tags_url: + type: string + format: uri + blobs_url: + type: string + git_tags_url: + type: string + git_refs_url: + type: string + trees_url: + type: string + statuses_url: + type: string + languages_url: + type: string + format: uri + stargazers_url: + type: string + format: uri + contributors_url: + type: string + format: uri + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + commits_url: + type: string + git_commits_url: + type: string + comments_url: + type: string + issue_comment_url: + type: string + contents_url: + type: string + compare_url: + type: string + merges_url: + type: string + format: uri + archive_url: + type: string + downloads_url: + type: string + format: uri + issues_url: + type: string + pulls_url: + type: string + milestones_url: + type: string + notifications_url: + type: string + labels_url: + type: string + releases_url: + type: string + deployments_url: + type: string + format: uri + git_url: + type: string + ssh_url: + type: string + clone_url: + type: string + svn_url: + type: string + format: uri + forks: + type: integer + open_issues: + type: integer + watchers: + type: integer + topics: + type: array + items: + type: string + mirror_url: + type: + - string + - 'null' + format: uri + has_issues: + type: boolean + has_projects: + type: boolean + has_pages: + type: boolean + has_wiki: + type: boolean + has_downloads: + type: boolean + has_discussions: + type: boolean + archived: + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + type: string + license: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/license-simple" + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + required: + - admin + - pull + - push + text_matches: + "$ref": "#/components/schemas/search-result-text-matches" + temp_clone_token: + type: string + allow_merge_commit: + type: boolean + allow_squash_merge: + type: boolean + allow_rebase_merge: + type: boolean + allow_auto_merge: + type: boolean + delete_branch_on_merge: + type: boolean + allow_forking: + type: boolean + is_template: + type: boolean + web_commit_signoff_required: + type: boolean + examples: + - false + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + - score + topic-search-result-item: + title: Topic Search Result Item + description: Topic Search Result Item + type: object + properties: + name: + type: string + display_name: + type: + - string + - 'null' + short_description: + type: + - string + - 'null' + description: + type: + - string + - 'null' + created_by: + type: + - string + - 'null' + released: + type: + - string + - 'null' + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + featured: + type: boolean + curated: + type: boolean + score: + type: number + repository_count: + type: + - integer + - 'null' + logo_url: + type: + - string + - 'null' + format: uri + text_matches: + "$ref": "#/components/schemas/search-result-text-matches" + related: + type: + - array + - 'null' + items: + type: object + properties: + topic_relation: + type: object + properties: + id: + type: integer + name: + type: string + topic_id: + type: integer + relation_type: + type: string + aliases: + type: + - array + - 'null' + items: + type: object + properties: + topic_relation: + type: object + properties: + id: + type: integer + name: + type: string + topic_id: + type: integer + relation_type: + type: string + required: + - name + - display_name + - short_description + - description + - created_by + - released + - created_at + - updated_at + - featured + - curated + - score + user-search-result-item: + title: User Search Result Item + description: User Search Result Item + type: object + properties: + login: + type: string + id: + type: integer + node_id: + type: string + avatar_url: + type: string + format: uri + gravatar_id: + type: + - string + - 'null' + url: + type: string + format: uri + html_url: + type: string + format: uri + followers_url: + type: string + format: uri + subscriptions_url: + type: string + format: uri + organizations_url: + type: string + format: uri + repos_url: + type: string + format: uri + received_events_url: + type: string + format: uri + type: + type: string + score: + type: number + following_url: + type: string + gists_url: + type: string + starred_url: + type: string + events_url: + type: string + public_repos: + type: integer + public_gists: + type: integer + followers: + type: integer + following: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + name: + type: + - string + - 'null' + bio: + type: + - string + - 'null' + email: + type: + - string + - 'null' + format: email + location: + type: + - string + - 'null' + site_admin: + type: boolean + hireable: + type: + - boolean + - 'null' + text_matches: + "$ref": "#/components/schemas/search-result-text-matches" + blog: + type: + - string + - 'null' + company: + type: + - string + - 'null' + suspended_at: + type: + - string + - 'null' + format: date-time + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - score + private-user: + title: Private User + description: Private User + type: object + properties: + login: + type: string + examples: + - octocat + id: + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + examples: + - https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: + - string + - 'null' + examples: + - 41d064eb2195891e12d0413f63227ea7 + url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat + html_url: + type: string + format: uri + examples: + - https://github.com/octocat + followers_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/followers + following_url: + type: string + examples: + - https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + examples: + - https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + examples: + - https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/repos + events_url: + type: string + examples: + - https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/received_events + type: + type: string + examples: + - User + site_admin: + type: boolean + name: + type: + - string + - 'null' + examples: + - monalisa octocat + company: + type: + - string + - 'null' + examples: + - GitHub + blog: + type: + - string + - 'null' + examples: + - https://github.com/blog + location: + type: + - string + - 'null' + examples: + - San Francisco + email: + type: + - string + - 'null' + format: email + examples: + - octocat@github.com + hireable: + type: + - boolean + - 'null' + bio: + type: + - string + - 'null' + examples: + - There once was... + twitter_username: + type: + - string + - 'null' + examples: + - monalisa + public_repos: + type: integer + examples: + - 2 + public_gists: + type: integer + examples: + - 1 + followers: + type: integer + examples: + - 20 + following: + type: integer + examples: + - 0 + created_at: + type: string + format: date-time + examples: + - '2008-01-14T04:33:35Z' + updated_at: + type: string + format: date-time + examples: + - '2008-01-14T04:33:35Z' + private_gists: + type: integer + examples: + - 81 + total_private_repos: + type: integer + examples: + - 100 + owned_private_repos: + type: integer + examples: + - 100 + disk_usage: + type: integer + examples: + - 10000 + collaborators: + type: integer + examples: + - 8 + two_factor_authentication: + type: boolean + examples: + - true + plan: + type: object + properties: + collaborators: + type: integer + name: + type: string + space: + type: integer + private_repos: + type: integer + required: + - collaborators + - name + - space + - private_repos + suspended_at: + type: + - string + - 'null' + format: date-time + business_plus: + type: boolean + ldap_dn: + type: string + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - bio + - blog + - company + - email + - followers + - following + - hireable + - location + - name + - public_gists + - public_repos + - created_at + - updated_at + - collaborators + - disk_usage + - owned_private_repos + - private_gists + - total_private_repos + - two_factor_authentication + codespaces-secret: + title: Codespaces Secret + description: Secrets for a GitHub Codespace. + type: object + properties: + name: + description: The name of the secret + type: string + examples: + - SECRET_NAME + created_at: + description: The date and time at which the secret was created, in ISO 8601 + format':' YYYY-MM-DDTHH:MM:SSZ. + type: string + format: date-time + updated_at: + description: The date and time at which the secret was last updated, in + ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + type: string + format: date-time + visibility: + description: The type of repositories in the organization that the secret + is visible to + enum: + - all + - private + - selected + type: string + selected_repositories_url: + description: The API URL at which the list of repositories this secret is + visible to can be retrieved + type: string + format: uri + examples: + - https://api.github.com/user/secrets/SECRET_NAME/repositories + required: + - name + - created_at + - updated_at + - visibility + - selected_repositories_url + codespaces-user-public-key: + title: CodespacesUserPublicKey + description: The public key used for setting user Codespaces' Secrets. + type: object + properties: + key_id: + description: The identifier for the key. + type: string + examples: + - '1234567' + key: + description: The Base64 encoded public key. + type: string + examples: + - hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= + required: + - key_id + - key + codespace-export-details: + type: object + title: Fetches information about an export of a codespace. + description: An export of a codespace. Also, latest export details for a codespace + can be fetched with id = latest + properties: + state: + type: + - string + - 'null' + description: State of the latest export + examples: + - succeeded | failed | in_progress + completed_at: + description: Completion time of the last export operation + type: + - string + - 'null' + format: date-time + examples: + - '2021-01-01T19:01:12Z' + branch: + type: + - string + - 'null' + description: Name of the exported branch + examples: + - codespace-monalisa-octocat-hello-world-g4wpq6h95q + sha: + type: + - string + - 'null' + description: Git commit SHA of the exported branch + examples: + - fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 + id: + type: string + description: Id for the export details + examples: + - latest + export_url: + type: string + description: Url for fetching export details + examples: + - https://api.github.com/user/codespaces/:name/exports/latest + html_url: + type: + - string + - 'null' + description: Web url for the exported branch + examples: + - https://github.com/octocat/hello-world/tree/:branch + email: + title: Email + description: Email + type: object + properties: + email: + type: string + format: email + examples: + - octocat@github.com + primary: + type: boolean + examples: + - true + verified: + type: boolean + examples: + - true + visibility: + type: + - string + - 'null' + examples: + - public + required: + - email + - primary + - verified + - visibility + gpg-key: + title: GPG Key + description: A unique encryption key + type: object + properties: + id: + type: integer + examples: + - 3 + name: + type: + - string + - 'null' + examples: + - Octocat's GPG Key + primary_key_id: + type: + - integer + - 'null' + key_id: + type: string + examples: + - 3262EFF25BA0D270 + public_key: + type: string + examples: + - xsBNBFayYZ... + emails: + type: array + items: + type: object + properties: + email: + type: string + verified: + type: boolean + examples: + - email: octocat@users.noreply.github.com + verified: true + subkeys: + type: array + items: + type: object + properties: + id: + type: integer + primary_key_id: + type: integer + key_id: + type: string + public_key: + type: string + emails: + type: array + items: {} + subkeys: + type: array + items: {} + can_sign: + type: boolean + can_encrypt_comms: + type: boolean + can_encrypt_storage: + type: boolean + can_certify: + type: boolean + created_at: + type: string + expires_at: + type: + - string + - 'null' + raw_key: + type: + - string + - 'null' + revoked: + type: boolean + examples: + - id: 4 + primary_key_id: 3 + key_id: 4A595D4C72EE49C7 + public_key: zsBNBFayYZ... + emails: [] + subkeys: [] + can_sign: false + can_encrypt_comms: true + can_encrypt_storage: true + can_certify: false + created_at: '2016-03-24T11:31:04-06:00' + expires_at: + revoked: false + can_sign: + type: boolean + examples: + - true + can_encrypt_comms: + type: boolean + can_encrypt_storage: + type: boolean + can_certify: + type: boolean + examples: + - true + created_at: + type: string + format: date-time + examples: + - '2016-03-24T11:31:04-06:00' + expires_at: + type: + - string + - 'null' + format: date-time + revoked: + type: boolean + examples: + - true + raw_key: + type: + - string + - 'null' + required: + - id + - primary_key_id + - key_id + - raw_key + - public_key + - created_at + - expires_at + - can_sign + - can_encrypt_comms + - can_encrypt_storage + - can_certify + - emails + - subkeys + - revoked + key: + title: Key + description: Key + type: object + properties: + key: + type: string + id: + type: integer + url: + type: string + title: + type: string + created_at: + type: string + format: date-time + verified: + type: boolean + read_only: + type: boolean + required: + - key + - id + - url + - title + - created_at + - verified + - read_only + marketplace-account: + title: Marketplace Account + type: object + properties: + url: + type: string + format: uri + id: + type: integer + type: + type: string + node_id: + type: string + login: + type: string + email: + type: + - string + - 'null' + format: email + organization_billing_email: + type: + - string + - 'null' + format: email + required: + - url + - id + - type + - login + user-marketplace-purchase: + title: User Marketplace Purchase + description: User Marketplace Purchase + type: object + properties: + billing_cycle: + type: string + examples: + - monthly + next_billing_date: + type: + - string + - 'null' + format: date-time + examples: + - '2017-11-11T00:00:00Z' + unit_count: + type: + - integer + - 'null' + on_free_trial: + type: boolean + examples: + - true + free_trial_ends_on: + type: + - string + - 'null' + format: date-time + examples: + - '2017-11-11T00:00:00Z' + updated_at: + type: + - string + - 'null' + format: date-time + examples: + - '2017-11-02T01:12:12Z' + account: + "$ref": "#/components/schemas/marketplace-account" + plan: + "$ref": "#/components/schemas/marketplace-listing-plan" + required: + - billing_cycle + - next_billing_date + - unit_count + - updated_at + - on_free_trial + - free_trial_ends_on + - account + - plan + ssh-signing-key: + title: SSH Signing Key + description: A public SSH key used to sign Git commits + type: object + properties: + key: + type: string + id: + type: integer + title: + type: string + created_at: + type: string + format: date-time + required: + - key + - id + - title + - created_at + starred-repository: + title: Starred Repository + description: Starred Repository + type: object + properties: + starred_at: + type: string + format: date-time + repo: + "$ref": "#/components/schemas/repository" + required: + - starred_at + - repo + hovercard: + title: Hovercard + description: Hovercard + type: object + properties: + contexts: + type: array + items: + type: object + properties: + message: + type: string + octicon: + type: string + required: + - message + - octicon + required: + - contexts + key-simple: + title: Key Simple + description: Key Simple + type: object + properties: + id: + type: integer + key: + type: string + required: + - key + - id + simple-installation: + title: Simple Installation + description: The GitHub App installation. This property is included when the + event is configured for and sent to a GitHub App. + type: object + properties: + id: + description: The ID of the installation. + type: integer + examples: + - 1 + node_id: + description: The global node ID of the installation. + type: string + examples: + - MDQ6VXNlcjU4MzIzMQ== + required: + - id + - node_id + simple-check-suite: + description: A suite of checks performed on the code of a given code change + type: object + properties: + after: + type: + - string + - 'null' + examples: + - d6fde92930d4715a2b49857d24b940956b26d2d3 + app: + "$ref": "#/components/schemas/integration" + before: + type: + - string + - 'null' + examples: + - 146e867f55c26428e5f9fade55a9bbf5e95a7912 + conclusion: + type: + - string + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - skipped + - timed_out + - action_required + - stale + - startup_failure + - + examples: + - neutral + created_at: + type: string + format: date-time + head_branch: + type: + - string + - 'null' + examples: + - master + head_sha: + description: The SHA of the head commit that is being checked. + type: string + examples: + - '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' + id: + type: integer + examples: + - 5 + node_id: + type: string + examples: + - MDEwOkNoZWNrU3VpdGU1 + pull_requests: + type: array + items: + "$ref": "#/components/schemas/pull-request-minimal" + repository: + "$ref": "#/components/schemas/minimal-repository" + status: + type: string + enum: + - queued + - in_progress + - completed + - pending + - waiting + examples: + - completed + updated_at: + type: string + format: date-time + url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/check-suites/5 + check-run-with-simple-check-suite: + title: CheckRun + description: A check performed on the code of a given code change + type: object + properties: + app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + check_suite: + "$ref": "#/components/schemas/simple-check-suite" + completed_at: + type: + - string + - 'null' + format: date-time + examples: + - '2018-05-04T01:14:52Z' + conclusion: + type: + - string + - 'null' + enum: + - waiting + - pending + - startup_failure + - stale + - success + - failure + - neutral + - cancelled + - skipped + - timed_out + - action_required + - + examples: + - neutral + deployment: + "$ref": "#/components/schemas/deployment-simple" + details_url: + type: string + examples: + - https://example.com + external_id: + type: string + examples: + - '42' + head_sha: + description: The SHA of the commit that is being checked. + type: string + examples: + - '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' + html_url: + type: string + examples: + - https://github.com/github/hello-world/runs/4 + id: + description: The id of the check. + type: integer + examples: + - 21 + name: + description: The name of the check. + type: string + examples: + - test-coverage + node_id: + type: string + examples: + - MDg6Q2hlY2tSdW40 + output: + type: object + properties: + annotations_count: + type: integer + annotations_url: + type: string + format: uri + summary: + type: + - string + - 'null' + text: + type: + - string + - 'null' + title: + type: + - string + - 'null' + required: + - title + - summary + - text + - annotations_count + - annotations_url + pull_requests: + type: array + items: + "$ref": "#/components/schemas/pull-request-minimal" + started_at: + type: string + format: date-time + examples: + - '2018-05-04T01:14:52Z' + status: + description: The phase of the lifecycle that the check is currently in. + type: string + enum: + - queued + - in_progress + - completed + - pending + examples: + - queued + url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/check-runs/4 + required: + - id + - node_id + - head_sha + - name + - url + - html_url + - details_url + - status + - conclusion + - started_at + - completed_at + - external_id + - check_suite + - output + - app + - pull_requests + projects-v2-item-content-type: + title: Projects v2 Item Content Type + description: The type of content tracked in a project item + type: string + enum: + - Issue + - PullRequest + - DraftIssue + projects-v2-item: + title: Projects v2 Item + description: An item belonging to a project + type: object + properties: + id: + type: number + node_id: + type: string + project_node_id: + type: string + content_node_id: + type: string + content_type: + "$ref": "#/components/schemas/projects-v2-item-content-type" + creator: + "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + examples: + - '2022-04-28T12:00:00Z' + updated_at: + type: string + format: date-time + examples: + - '2022-04-28T12:00:00Z' + archived_at: + type: + - string + - 'null' + format: date-time + examples: + - '2022-04-28T12:00:00Z' + required: + - id + - content_node_id + - content_type + - created_at + - updated_at + - archived_at + webhook-branch-protection-rule-created: + title: branch protection rule created event + type: object + properties: + action: + type: string + enum: + - created + enterprise: + "$ref": "#/components/schemas/enterprise" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple" + repository: + "$ref": "#/components/schemas/repository" + rule: + title: branch protection rule + description: The branch protection rule. Includes a `name` and all the [branch + protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) + applied to branches that match the name. Binary settings are boolean. + Multi-level configurations are one of `off`, `non_admins`, or `everyone`. + Actor and build lists are arrays of strings. + type: object + properties: + admin_enforced: + type: boolean + allow_deletions_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + allow_force_pushes_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + authorized_actor_names: + type: array + items: + type: string + authorized_actors_only: + type: boolean + authorized_dismissal_actors_only: + type: boolean + create_protected: + type: boolean + created_at: + type: string + format: date-time + dismiss_stale_reviews_on_push: + type: boolean + id: + type: integer + ignore_approvals_from_contributors: + type: boolean + linear_history_requirement_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + merge_queue_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + name: + type: string + pull_request_reviews_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + repository_id: + type: integer + require_code_owner_review: + type: boolean + required_approving_review_count: + type: integer + required_conversation_resolution_level: + type: string + enum: + - 'off' + - non_admins + - everyone + required_deployments_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + required_status_checks: + type: array + items: + type: string + required_status_checks_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + signature_requirement_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + strict_required_status_checks_policy: + type: boolean + updated_at: + type: string + format: date-time + required: + - id + - repository_id + - name + - created_at + - updated_at + - pull_request_reviews_enforcement_level + - required_approving_review_count + - dismiss_stale_reviews_on_push + - require_code_owner_review + - authorized_dismissal_actors_only + - ignore_approvals_from_contributors + - required_status_checks + - required_status_checks_enforcement_level + - strict_required_status_checks_policy + - signature_requirement_enforcement_level + - linear_history_requirement_enforcement_level + - admin_enforced + - allow_force_pushes_enforcement_level + - allow_deletions_enforcement_level + - merge_queue_enforcement_level + - required_deployments_enforcement_level + - required_conversation_resolution_level + - authorized_actors_only + - authorized_actor_names + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - rule + - repository + - sender + webhook-branch-protection-rule-deleted: + title: branch protection rule deleted event + type: object + properties: + action: + type: string + enum: + - deleted + enterprise: + "$ref": "#/components/schemas/enterprise" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple" + repository: + "$ref": "#/components/schemas/repository" + rule: + title: branch protection rule + description: The branch protection rule. Includes a `name` and all the [branch + protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) + applied to branches that match the name. Binary settings are boolean. + Multi-level configurations are one of `off`, `non_admins`, or `everyone`. + Actor and build lists are arrays of strings. + type: object + properties: + admin_enforced: + type: boolean + allow_deletions_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + allow_force_pushes_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + authorized_actor_names: + type: array + items: + type: string + authorized_actors_only: + type: boolean + authorized_dismissal_actors_only: + type: boolean + create_protected: + type: boolean + created_at: + type: string + format: date-time + dismiss_stale_reviews_on_push: + type: boolean + id: + type: integer + ignore_approvals_from_contributors: + type: boolean + linear_history_requirement_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + merge_queue_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + name: + type: string + pull_request_reviews_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + repository_id: + type: integer + require_code_owner_review: + type: boolean + required_approving_review_count: + type: integer + required_conversation_resolution_level: + type: string + enum: + - 'off' + - non_admins + - everyone + required_deployments_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + required_status_checks: + type: array + items: + type: string + required_status_checks_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + signature_requirement_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + strict_required_status_checks_policy: + type: boolean + updated_at: + type: string + format: date-time + required: + - id + - repository_id + - name + - created_at + - updated_at + - pull_request_reviews_enforcement_level + - required_approving_review_count + - dismiss_stale_reviews_on_push + - require_code_owner_review + - authorized_dismissal_actors_only + - ignore_approvals_from_contributors + - required_status_checks + - required_status_checks_enforcement_level + - strict_required_status_checks_policy + - signature_requirement_enforcement_level + - linear_history_requirement_enforcement_level + - admin_enforced + - allow_force_pushes_enforcement_level + - allow_deletions_enforcement_level + - merge_queue_enforcement_level + - required_deployments_enforcement_level + - required_conversation_resolution_level + - authorized_actors_only + - authorized_actor_names + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - rule + - repository + - sender + webhook-branch-protection-rule-edited: + title: branch protection rule edited event + type: object + properties: + action: + type: string + enum: + - edited + changes: + description: If the action was `edited`, the changes to the rule. + type: object + properties: + admin_enforced: + type: object + properties: + from: + type: + - boolean + - 'null' + required: + - from + authorized_actor_names: + type: object + properties: + from: + type: array + items: + type: string + required: + - from + authorized_actors_only: + type: object + properties: + from: + type: + - boolean + - 'null' + required: + - from + authorized_dismissal_actors_only: + type: object + properties: + from: + type: + - boolean + - 'null' + required: + - from + linear_history_requirement_enforcement_level: + type: object + properties: + from: + type: string + enum: + - 'off' + - non_admins + - everyone + required: + - from + required_status_checks: + type: object + properties: + from: + type: array + items: + type: string + required: + - from + required_status_checks_enforcement_level: + type: object + properties: + from: + type: string + enum: + - 'off' + - non_admins + - everyone + required: + - from + enterprise: + "$ref": "#/components/schemas/enterprise" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple" + repository: + "$ref": "#/components/schemas/repository" + rule: + title: branch protection rule + description: The branch protection rule. Includes a `name` and all the [branch + protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) + applied to branches that match the name. Binary settings are boolean. + Multi-level configurations are one of `off`, `non_admins`, or `everyone`. + Actor and build lists are arrays of strings. + type: object + properties: + admin_enforced: + type: boolean + allow_deletions_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + allow_force_pushes_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + authorized_actor_names: + type: array + items: + type: string + authorized_actors_only: + type: boolean + authorized_dismissal_actors_only: + type: boolean + create_protected: + type: boolean + created_at: + type: string + format: date-time + dismiss_stale_reviews_on_push: + type: boolean + id: + type: integer + ignore_approvals_from_contributors: + type: boolean + linear_history_requirement_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + merge_queue_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + name: + type: string + pull_request_reviews_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + repository_id: + type: integer + require_code_owner_review: + type: boolean + required_approving_review_count: + type: integer + required_conversation_resolution_level: + type: string + enum: + - 'off' + - non_admins + - everyone + required_deployments_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + required_status_checks: + type: array + items: + type: string + required_status_checks_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + signature_requirement_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + strict_required_status_checks_policy: + type: boolean + updated_at: + type: string + format: date-time + required: + - id + - repository_id + - name + - created_at + - updated_at + - pull_request_reviews_enforcement_level + - required_approving_review_count + - dismiss_stale_reviews_on_push + - require_code_owner_review + - authorized_dismissal_actors_only + - ignore_approvals_from_contributors + - required_status_checks + - required_status_checks_enforcement_level + - strict_required_status_checks_policy + - signature_requirement_enforcement_level + - linear_history_requirement_enforcement_level + - admin_enforced + - allow_force_pushes_enforcement_level + - allow_deletions_enforcement_level + - merge_queue_enforcement_level + - required_deployments_enforcement_level + - required_conversation_resolution_level + - authorized_actors_only + - authorized_actor_names + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - rule + - repository + - sender + webhook-check-run-completed: + title: Check Run Completed Event + type: object + properties: + action: + type: string + enum: + - completed + check_run: + "$ref": "#/components/schemas/check-run-with-simple-check-suite" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple" + repository: + "$ref": "#/components/schemas/repository" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - check_run + - repository + - sender + webhook-check-run-completed-form-encoded: + title: Check Run Completed Event + description: The check_run.completed webhook encoded with URL encoding + type: object + properties: + payload: + description: A URL-encoded string of the check_run.completed JSON payload. + The decoded payload is a JSON object. + type: string + required: + - payload + webhook-check-run-created: + title: Check Run Created Event + type: object + properties: + action: + type: string + enum: + - created + check_run: + "$ref": "#/components/schemas/check-run-with-simple-check-suite" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple" + repository: + "$ref": "#/components/schemas/repository" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - check_run + - repository + - sender + webhook-check-run-created-form-encoded: + title: Check Run Created Event + description: The check_run.created webhook encoded with URL encoding + type: object + properties: + payload: + description: A URL-encoded string of the check_run.created JSON payload. + The decoded payload is a JSON object. + type: string + required: + - payload + webhook-check-suite-completed: + title: check_suite completed event + type: object + properties: + action: + type: string + enum: + - completed + actions_meta: + type: + - object + - 'null' + check_suite: + description: The [check_suite](https://docs.github.com/rest/reference/checks#suites). + type: object + properties: + after: + type: + - string + - 'null' + app: + title: App + description: GitHub apps are a new way to extend GitHub. They can be + installed directly on organizations and user accounts and granted + access to specific repositories. They come with granular permissions + and built-in webhooks. GitHub apps are first class actors within GitHub. + type: object + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + - merge_group + - pull_request_review_thread + - workflow_job + - merge_queue_entry + - security_and_analysis + - projects_v2_item + - secret_scanning_alert_location + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + - admin + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + - admin + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + team_discussions: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + before: + type: + - string + - 'null' + check_runs_url: + type: string + format: uri + conclusion: + description: The summary conclusion for all check runs that are part + of the check suite. Can be one of `success`, `failure`, `neutral`, + `cancelled`, `timed_out`, `action_required` or `stale`. This value + will be `null` until the check run has `completed`. + type: + - string + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + - skipped + - startup_failure + created_at: + type: string + format: date-time + head_branch: + description: The head branch name the changes are on. + type: + - string + - 'null' + head_commit: + title: SimpleCommit + type: object + properties: + author: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: + - string + - 'null' + format: email + name: + description: The git author's name. + type: string + username: + type: string + required: + - email + - name + committer: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: + - string + - 'null' + format: email + name: + description: The git author's name. + type: string + username: + type: string + required: + - email + - name + id: + type: string + message: + type: string + timestamp: + type: string + tree_id: + type: string + required: + - id + - tree_id + - message + - timestamp + - author + - committer + head_sha: + description: The SHA of the head commit that is being checked. + type: string + id: + type: integer + latest_check_runs_count: + type: integer + node_id: + type: string + pull_requests: + description: An array of pull requests that match this check suite. + A pull request matches a check suite if they have the same `head_sha` + and `head_branch`. When the check suite's `head_branch` is in a forked + repository it will be `null` and the `pull_requests` array will be + empty. + type: array + items: + title: Check Run Pull Request + type: object + properties: + base: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + head: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + id: + type: integer + number: + type: integer + url: + type: string + format: uri + required: + - url + - id + - number + - head + - base + rerequestable: + type: boolean + runs_rerequestable: + type: boolean + status: + description: The summary status for all check runs that are part of + the check suite. Can be `requested`, `in_progress`, or `completed`. + type: + - string + - 'null' + enum: + - requested + - in_progress + - completed + - queued + - + - pending + updated_at: + type: string + format: date-time + url: + description: URL that points to the check suite API resource. + type: string + format: uri + required: + - id + - node_id + - head_branch + - head_sha + - status + - conclusion + - url + - before + - after + - pull_requests + - app + - created_at + - updated_at + - latest_check_runs_count + - check_runs_url + - head_commit + enterprise: + "$ref": "#/components/schemas/enterprise" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple" + repository: + "$ref": "#/components/schemas/repository" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - check_suite + - repository + - sender + webhook-code-scanning-alert-appeared-in-branch: + title: code_scanning_alert appeared_in_branch event + type: object + properties: + action: + type: string + enum: + - appeared_in_branch + alert: + description: The code scanning alert involved in the event. + type: object + properties: + created_at: + description: 'The time that the alert was created in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ.`' + type: string + format: date-time + dismissed_at: + description: 'The time that the alert was dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + type: + - string + - 'null' + format: date-time + dismissed_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + dismissed_reason: + description: 'The reason for dismissing or closing the alert. Can be + one of: `false positive`, `won''t fix`, and `used in tests`.' + type: + - string + - 'null' + enum: + - false positive + - won't fix + - used in tests + - + html_url: + description: The GitHub URL of the alert resource. + type: string + format: uri + instances: + type: array + items: + title: Alert Instance + type: + - object + - 'null' + properties: + analysis_key: + description: Identifies the configuration under which the analysis + was executed. For example, in GitHub Actions this includes the + workflow filename and job name. + type: string + classifications: + type: array + items: + type: string + commit_sha: + type: string + environment: + description: Identifies the variable values associated with the + environment in which the analysis that generated this alert + instance was performed, such as the language that was analyzed. + type: string + location: + type: object + properties: + end_column: + type: integer + end_line: + type: integer + path: + type: string + start_column: + type: integer + start_line: + type: integer + message: + type: object + properties: + text: + type: string + ref: + description: The full Git reference, formatted as `refs/heads/Hi! This is an area for us to collaborate as a team
" + body_version: 0d495416a700fb06133c612575d92bfb + comments_count: 0 + comments_url: https://api.github.com/teams/2343027/discussions/1/comments + created_at: '2018-01-25T18:56:31Z' + last_edited_at: + html_url: https://github.com/orgs/github/teams/justice-league/discussions/1 + node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ== + number: 1 + pinned: false + private: false + team_url: https://api.github.com/teams/2343027 + title: Our first team post + updated_at: '2018-01-25T18:56:31Z' + url: https://api.github.com/teams/2343027/discussions/1 + reactions: + url: https://api.github.com/teams/2343027/discussions/1/reactions + total_count: 5 + "+1": 3 + "-1": 1 + laugh: 0 + confused: 0 + heart: 1 + hooray: 0 + eyes: 1 + rocket: 1 + team-discussion: + value: + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Hi! This is an area for us to collaborate as a team. + body_html: "Hi! This is an area for us to collaborate as a team
" + body_version: 0d495416a700fb06133c612575d92bfb + comments_count: 0 + comments_url: https://api.github.com/teams/2343027/discussions/1/comments + created_at: '2018-01-25T18:56:31Z' + last_edited_at: + html_url: https://github.com/orgs/github/teams/justice-league/discussions/1 + node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ== + number: 1 + pinned: false + private: false + team_url: https://api.github.com/teams/2343027 + title: Our first team post + updated_at: '2018-01-25T18:56:31Z' + url: https://api.github.com/teams/2343027/discussions/1 + reactions: + url: https://api.github.com/teams/2343027/discussions/1/reactions + total_count: 5 + "+1": 3 + "-1": 1 + laugh: 0 + confused: 0 + heart: 1 + hooray: 0 + eyes: 1 + rocket: 1 + team-discussion-2: + value: + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Hi! This is an area for us to collaborate as a team. + body_html: "Hi! This is an area for us to collaborate as a team
" + body_version: 0d495416a700fb06133c612575d92bfb + comments_count: 1 + comments_url: https://api.github.com/teams/2343027/discussions/1/comments + created_at: '2018-01-25T18:56:31Z' + last_edited_at: '2018-01-26T18:22:20Z' + html_url: https://github.com/orgs/github/teams/justice-league/discussions/1 + node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ== + number: 1 + pinned: false + private: false + team_url: https://api.github.com/teams/2343027 + title: Welcome to our first team post + updated_at: '2018-01-26T18:22:20Z' + url: https://api.github.com/teams/2343027/discussions/1 + reactions: + url: https://api.github.com/teams/2343027/discussions/1/reactions + total_count: 5 + "+1": 3 + "-1": 1 + laugh: 0 + confused: 0 + heart: 1 + hooray: 0 + eyes: 1 + rocket: 1 + team-discussion-comment-items: + value: + - author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Do you like apples? + body_html: "Do you like apples?
" + body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51 + created_at: '2018-01-15T23:53:58Z' + last_edited_at: + discussion_url: https://api.github.com/teams/2403582/discussions/1 + html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= + number: 1 + updated_at: '2018-01-15T23:53:58Z' + url: https://api.github.com/teams/2403582/discussions/1/comments/1 + reactions: + url: https://api.github.com/teams/2403582/discussions/1/reactions + total_count: 5 + "+1": 3 + "-1": 1 + laugh: 0 + confused: 0 + heart: 1 + hooray: 0 + eyes: 1 + rocket: 1 + team-discussion-comment: + value: + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Do you like apples? + body_html: "Do you like apples?
" + body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51 + created_at: '2018-01-15T23:53:58Z' + last_edited_at: + discussion_url: https://api.github.com/teams/2403582/discussions/1 + html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= + number: 1 + updated_at: '2018-01-15T23:53:58Z' + url: https://api.github.com/teams/2403582/discussions/1/comments/1 + reactions: + url: https://api.github.com/teams/2403582/discussions/1/reactions + total_count: 5 + "+1": 3 + "-1": 1 + laugh: 0 + confused: 0 + heart: 1 + hooray: 0 + eyes: 1 + rocket: 1 + team-discussion-comment-2: + value: + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Do you like pineapples? + body_html: "Do you like pineapples?
" + body_version: e6907b24d9c93cc0c5024a7af5888116 + created_at: '2018-01-15T23:53:58Z' + last_edited_at: '2018-01-26T18:22:20Z' + discussion_url: https://api.github.com/teams/2403582/discussions/1 + html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= + number: 1 + updated_at: '2018-01-26T18:22:20Z' + url: https://api.github.com/teams/2403582/discussions/1/comments/1 + reactions: + url: https://api.github.com/teams/2403582/discussions/1/reactions + total_count: 5 + "+1": 3 + "-1": 1 + laugh: 0 + confused: 0 + heart: 1 + hooray: 0 + eyes: 1 + rocket: 1 + reaction-items: + value: + - id: 1 + node_id: MDg6UmVhY3Rpb24x + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + content: heart + created_at: '2016-05-20T20:09:31Z' + reaction: + value: + id: 1 + node_id: MDg6UmVhY3Rpb24x + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + content: heart + created_at: '2016-05-20T20:09:31Z' + team-membership-response-if-user-is-a-team-maintainer: + summary: Response if user is a team maintainer + value: + url: https://api.github.com/teams/1/memberships/octocat + role: maintainer + state: active + team-membership-response-if-users-membership-with-team-is-now-pending: + summary: Response if user's membership with team is now pending + value: + url: https://api.github.com/teams/1/memberships/octocat + role: member + state: pending + team-project-items: + value: + - owner_url: https://api.github.com/orgs/octocat + url: https://api.github.com/projects/1002605 + html_url: https://github.com/orgs/api-playground/projects/1 + columns_url: https://api.github.com/projects/1002605/columns + id: 1002605 + node_id: MDc6UHJvamVjdDEwMDI2MDU= + name: Organization Roadmap + body: High-level roadmap for the upcoming year. + number: 1 + state: open + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2011-04-11T20:09:31Z' + updated_at: '2014-03-04T18:58:10Z' + organization_permission: write + private: false + permissions: + read: true + write: true + admin: false + team-project: + value: + owner_url: https://api.github.com/orgs/octocat + url: https://api.github.com/projects/1002605 + html_url: https://github.com/orgs/api-playground/projects/1 + columns_url: https://api.github.com/projects/1002605/columns + id: 1002605 + node_id: MDc6UHJvamVjdDEwMDI2MDU= + name: Organization Roadmap + body: High-level roadmap for the upcoming year. + number: 1 + state: open + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2011-04-11T20:09:31Z' + updated_at: '2014-03-04T18:58:10Z' + organization_permission: write + private: false + permissions: + read: true + write: true + admin: false + team-repository-alternative-response-with-repository-permissions: + value: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + maintain: false + push: false + triage: false + pull: true + role_name: read + allow_rebase_merge: true + template_repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World-Template + full_name: octocat/Hello-World-Template + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World-Template + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World-Template + archive_url: https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World-Template/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World-Template/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads + events_url: https://api.github.com/repos/octocat/Hello-World-Template/events + forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World-Template.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages + merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} + ssh_url: git@github.com:octocat/Hello-World-Template.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World-Template/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World-Template/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags + teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams + trees_url: https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World-Template.git + mirror_url: git:git.example.com/octocat/Hello-World-Template + hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks + svn_url: https://svn.github.com/octocat/Hello-World-Template + homepage: https://github.com + language: + forks: 9 + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues: 0 + open_issues_count: 0 + is_template: true + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + pull: true + triage: false + push: false + maintain: false + admin: false + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + team-items-response-if-child-teams-exist: + value: + - id: 2 + node_id: MDQ6VGVhbTI= + url: https://api.github.com/teams/2 + name: Original Roster + slug: original-roster + description: Started it all. + privacy: closed + permission: admin + members_url: https://api.github.com/teams/2/members{/member} + repositories_url: https://api.github.com/teams/2/repos + parent: + id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + html_url: https://github.com/orgs/rails/teams/core + project-card: + value: + url: https://api.github.com/projects/columns/cards/1478 + id: 1478 + node_id: MDExOlByb2plY3RDYXJkMTQ3OA== + note: Add payload for delete Project column + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2016-09-05T14:21:06Z' + updated_at: '2016-09-05T14:20:22Z' + archived: false + column_url: https://api.github.com/projects/columns/367 + content_url: https://api.github.com/repos/api-playground/projects-test/issues/3 + project_url: https://api.github.com/projects/120 + project-column: + value: + url: https://api.github.com/projects/columns/367 + project_url: https://api.github.com/projects/120 + cards_url: https://api.github.com/projects/columns/367/cards + id: 367 + node_id: MDEzOlByb2plY3RDb2x1bW4zNjc= + name: To Do + created_at: '2016-09-05T14:18:44Z' + updated_at: '2016-09-05T14:22:28Z' + project-card-items: + value: + - url: https://api.github.com/projects/columns/cards/1478 + id: 1478 + node_id: MDExOlByb2plY3RDYXJkMTQ3OA== + note: Add payload for delete Project column + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2016-09-05T14:21:06Z' + updated_at: '2016-09-05T14:20:22Z' + archived: false + column_url: https://api.github.com/projects/columns/367 + content_url: https://api.github.com/repos/api-playground/projects-test/issues/3 + project_url: https://api.github.com/projects/120 + project-3: + value: + owner_url: https://api.github.com/repos/api-playground/projects-test + url: https://api.github.com/projects/1002604 + html_url: https://github.com/api-playground/projects-test/projects/1 + columns_url: https://api.github.com/projects/1002604/columns + id: 1002604 + node_id: MDc6UHJvamVjdDEwMDI2MDQ= + name: Projects Documentation + body: Developer documentation project for the developer site. + number: 1 + state: open + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + project-collaborator-permission: + value: + permission: admin + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + project-column-items: + value: + - url: https://api.github.com/projects/columns/367 + project_url: https://api.github.com/projects/120 + cards_url: https://api.github.com/projects/columns/367/cards + id: 367 + node_id: MDEzOlByb2plY3RDb2x1bW4zNjc= + name: To Do + created_at: '2016-09-05T14:18:44Z' + updated_at: '2016-09-05T14:22:28Z' + rate-limit-overview: + value: + resources: + core: + limit: 5000 + remaining: 4999 + reset: 1372700873 + used: 1 + search: + limit: 30 + remaining: 18 + reset: 1372697452 + used: 12 + graphql: + limit: 5000 + remaining: 4993 + reset: 1372700389 + used: 7 + integration_manifest: + limit: 5000 + remaining: 4999 + reset: 1551806725 + used: 1 + code_scanning_upload: + limit: 500 + remaining: 499 + reset: 1551806725 + used: 1 + rate: + limit: 5000 + remaining: 4999 + reset: 1372700873 + used: 1 + full-repository-default-response: + summary: Default response + value: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: + forks_count: 9 + forks: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues_count: 0 + open_issues: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + has_discussions: false + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + pull: true + push: false + admin: false + allow_rebase_merge: true + template_repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World-Template + full_name: octocat/Hello-World-Template + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World-Template + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World-Template + archive_url: https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World-Template/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World-Template/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads + events_url: https://api.github.com/repos/octocat/Hello-World-Template/events + forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World-Template.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages + merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} + ssh_url: git@github.com:octocat/Hello-World-Template.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World-Template/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World-Template/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags + teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams + trees_url: https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World-Template.git + mirror_url: git:git.example.com/octocat/Hello-World-Template + hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks + svn_url: https://svn.github.com/octocat/Hello-World-Template + homepage: https://github.com + language: + forks: 9 + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues: 0 + open_issues_count: 0 + is_template: true + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + spdx_id: MIT + url: https://api.github.com/licenses/mit + node_id: MDc6TGljZW5zZW1pdA== + organization: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: Organization + site_admin: false + parent: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + source: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + full-repository: + value: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + language: + forks_count: 9 + forks: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues_count: 0 + open_issues: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + pull: true + push: false + admin: false + allow_rebase_merge: true + template_repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World-Template + full_name: octocat/Hello-World-Template + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World-Template + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World-Template + archive_url: https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World-Template/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World-Template/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads + events_url: https://api.github.com/repos/octocat/Hello-World-Template/events + forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World-Template.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages + merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} + ssh_url: git@github.com:octocat/Hello-World-Template.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World-Template/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World-Template/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags + teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams + trees_url: https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World-Template.git + mirror_url: git:git.example.com/octocat/Hello-World-Template + hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks + svn_url: https://svn.github.com/octocat/Hello-World-Template + homepage: https://github.com + language: + forks: 9 + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues: 0 + open_issues_count: 0 + is_template: true + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + allow_forking: true + web_commit_signoff_required: false + subscribers_count: 42 + network_count: 0 + organization: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: Organization + site_admin: false + parent: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + source: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + artifact-paginated: + value: + total_count: 2 + artifacts: + - id: 11 + node_id: MDg6QXJ0aWZhY3QxMQ== + name: Rails + size_in_bytes: 556 + url: https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11 + archive_download_url: https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip + expired: false + created_at: '2020-01-10T14:59:22Z' + expires_at: '2020-03-21T14:59:22Z' + updated_at: '2020-02-21T14:59:22Z' + workflow_run: + id: 2332938 + repository_id: 1296269 + head_repository_id: 1296269 + head_branch: main + head_sha: 328faa0536e6fef19753d9d91dc96a9931694ce3 + - id: 13 + node_id: MDg6QXJ0aWZhY3QxMw== + name: Test output + size_in_bytes: 453 + url: https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13 + archive_download_url: https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip + expired: false + created_at: '2020-01-10T14:59:22Z' + expires_at: '2020-03-21T14:59:22Z' + updated_at: '2020-02-21T14:59:22Z' + workflow_run: + id: 2332942 + repository_id: 1296269 + head_repository_id: 1296269 + head_branch: main + head_sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 + artifact: + value: + id: 11 + node_id: MDg6QXJ0aWZhY3QxMQ== + name: Rails + size_in_bytes: 556 + url: https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11 + archive_download_url: https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip + expired: false + created_at: '2020-01-10T14:59:22Z' + expires_at: '2020-01-21T14:59:22Z' + updated_at: '2020-01-21T14:59:22Z' + workflow_run: + id: 2332938 + repository_id: 1296269 + head_repository_id: 1296269 + head_branch: main + head_sha: 328faa0536e6fef19753d9d91dc96a9931694ce3 + actions-cache-usage: + value: + full_name: octo-org/Hello-World + active_caches_size_in_bytes: 2322142 + active_caches_count: 3 + actions-cache-list: + value: + total_count: 1 + actions_caches: + - id: 505 + ref: refs/heads/main + key: Linux-node-958aff96db2d75d67787d1e634ae70b659de937b + version: 73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0 + last_accessed_at: '2019-01-24T22:45:36.000Z' + created_at: '2019-01-24T22:45:36.000Z' + size_in_bytes: 1024 + job: + value: + id: 399444496 + run_id: 29679449 + run_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449 + node_id: MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng== + head_sha: f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0 + url: https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496 + html_url: https://github.com/octo-org/octo-repo/runs/399444496 + status: completed + conclusion: success + started_at: '2020-01-20T17:42:40Z' + completed_at: '2020-01-20T17:44:39Z' + name: build + steps: + - name: Set up job + status: completed + conclusion: success + number: 1 + started_at: '2020-01-20T09:42:40.000-08:00' + completed_at: '2020-01-20T09:42:41.000-08:00' + - name: Run actions/checkout@v2 + status: completed + conclusion: success + number: 2 + started_at: '2020-01-20T09:42:41.000-08:00' + completed_at: '2020-01-20T09:42:45.000-08:00' + - name: Set up Ruby + status: completed + conclusion: success + number: 3 + started_at: '2020-01-20T09:42:45.000-08:00' + completed_at: '2020-01-20T09:42:45.000-08:00' + - name: Run actions/cache@v3 + status: completed + conclusion: success + number: 4 + started_at: '2020-01-20T09:42:45.000-08:00' + completed_at: '2020-01-20T09:42:48.000-08:00' + - name: Install Bundler + status: completed + conclusion: success + number: 5 + started_at: '2020-01-20T09:42:48.000-08:00' + completed_at: '2020-01-20T09:42:52.000-08:00' + - name: Install Gems + status: completed + conclusion: success + number: 6 + started_at: '2020-01-20T09:42:52.000-08:00' + completed_at: '2020-01-20T09:42:53.000-08:00' + - name: Run Tests + status: completed + conclusion: success + number: 7 + started_at: '2020-01-20T09:42:53.000-08:00' + completed_at: '2020-01-20T09:42:59.000-08:00' + - name: Deploy to Heroku + status: completed + conclusion: success + number: 8 + started_at: '2020-01-20T09:42:59.000-08:00' + completed_at: '2020-01-20T09:44:39.000-08:00' + - name: Post actions/cache@v3 + status: completed + conclusion: success + number: 16 + started_at: '2020-01-20T09:44:39.000-08:00' + completed_at: '2020-01-20T09:44:39.000-08:00' + - name: Complete job + status: completed + conclusion: success + number: 17 + started_at: '2020-01-20T09:44:39.000-08:00' + completed_at: '2020-01-20T09:44:39.000-08:00' + check_run_url: https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496 + labels: + - self-hosted + - foo + - bar + runner_id: 1 + runner_name: my runner + runner_group_id: 2 + runner_group_name: my runner group + actions-repository-permissions: + value: + enabled: true + allowed_actions: selected + selected_actions_url: https://api.github.com/repositories/42/actions/permissions/selected-actions + actions-workflow-access-to-repository: + value: + access_level: organization + workflow-run-paginated: + value: + total_count: 1 + workflow_runs: + - id: 30433642 + name: Build + node_id: MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ== + check_suite_id: 42 + check_suite_node_id: MDEwOkNoZWNrU3VpdGU0Mg== + head_branch: master + head_sha: acb5820ced9479c074f688cc328bf03f341a511d + run_number: 562 + event: push + status: queued + conclusion: + workflow_id: 159038 + url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642 + html_url: https://github.com/octo-org/octo-repo/actions/runs/30433642 + pull_requests: [] + created_at: '2020-01-22T19:33:08Z' + updated_at: '2020-01-22T19:33:08Z' + actor: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + run_attempt: 1 + run_started_at: '2020-01-22T19:33:08Z' + triggering_actor: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + jobs_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs + logs_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs + check_suite_url: https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374 + artifacts_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts + cancel_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel + rerun_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun + workflow_url: https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038 + head_commit: + id: acb5820ced9479c074f688cc328bf03f341a511d + tree_id: d23f6eedb1e1b9610bbc754ddb5197bfe7271223 + message: Create linter.yaml + timestamp: '2020-01-22T19:33:05Z' + author: + name: Octo Cat + email: octocat@github.com + committer: + name: GitHub + email: noreply@github.com + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + head_repository: + id: 217723378 + node_id: MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg= + name: octo-repo + full_name: octo-org/octo-repo + private: true + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + html_url: https://github.com/octo-org/octo-repo + description: + fork: false + url: https://api.github.com/repos/octo-org/octo-repo + forks_url: https://api.github.com/repos/octo-org/octo-repo/forks + keys_url: https://api.github.com/repos/octo-org/octo-repo/keys{/key_id} + collaborators_url: https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator} + teams_url: https://api.github.com/repos/octo-org/octo-repo/teams + hooks_url: https://api.github.com/repos/octo-org/octo-repo/hooks + issue_events_url: https://api.github.com/repos/octo-org/octo-repo/issues/events{/number} + events_url: https://api.github.com/repos/octo-org/octo-repo/events + assignees_url: https://api.github.com/repos/octo-org/octo-repo/assignees{/user} + branches_url: https://api.github.com/repos/octo-org/octo-repo/branches{/branch} + tags_url: https://api.github.com/repos/octo-org/octo-repo/tags + blobs_url: https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha} + git_tags_url: https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha} + git_refs_url: https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha} + trees_url: https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha} + statuses_url: https://api.github.com/repos/octo-org/octo-repo/statuses/{sha} + languages_url: https://api.github.com/repos/octo-org/octo-repo/languages + stargazers_url: https://api.github.com/repos/octo-org/octo-repo/stargazers + contributors_url: https://api.github.com/repos/octo-org/octo-repo/contributors + subscribers_url: https://api.github.com/repos/octo-org/octo-repo/subscribers + subscription_url: https://api.github.com/repos/octo-org/octo-repo/subscription + commits_url: https://api.github.com/repos/octo-org/octo-repo/commits{/sha} + git_commits_url: https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha} + comments_url: https://api.github.com/repos/octo-org/octo-repo/comments{/number} + issue_comment_url: https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number} + contents_url: https://api.github.com/repos/octo-org/octo-repo/contents/{+path} + compare_url: https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head} + merges_url: https://api.github.com/repos/octo-org/octo-repo/merges + archive_url: https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref} + downloads_url: https://api.github.com/repos/octo-org/octo-repo/downloads + issues_url: https://api.github.com/repos/octo-org/octo-repo/issues{/number} + pulls_url: https://api.github.com/repos/octo-org/octo-repo/pulls{/number} + milestones_url: https://api.github.com/repos/octo-org/octo-repo/milestones{/number} + notifications_url: https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating} + labels_url: https://api.github.com/repos/octo-org/octo-repo/labels{/name} + releases_url: https://api.github.com/repos/octo-org/octo-repo/releases{/id} + deployments_url: https://api.github.com/repos/octo-org/octo-repo/deployments + workflow-run: + value: + id: 30433642 + name: Build + node_id: MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ== + check_suite_id: 42 + check_suite_node_id: MDEwOkNoZWNrU3VpdGU0Mg== + head_branch: main + head_sha: acb5820ced9479c074f688cc328bf03f341a511d + path: ".github/workflows/build.yml@main" + run_number: 562 + event: push + display_title: Update README.md + status: queued + conclusion: + workflow_id: 159038 + url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642 + html_url: https://github.com/octo-org/octo-repo/actions/runs/30433642 + pull_requests: [] + created_at: '2020-01-22T19:33:08Z' + updated_at: '2020-01-22T19:33:08Z' + actor: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + run_attempt: 1 + referenced_workflows: + - path: octocat/Hello-World/.github/workflows/deploy.yml@main + sha: 86e8bc9ecf7d38b1ed2d2cfb8eb87ba9b35b01db + ref: refs/heads/main + - path: octo-org/octo-repo/.github/workflows/report.yml@v2 + sha: 79e9790903e1c3373b1a3e3a941d57405478a232 + ref: refs/tags/v2 + - path: octo-org/octo-repo/.github/workflows/secure.yml@1595d4b6de6a9e9751fb270a41019ce507d4099e + sha: 1595d4b6de6a9e9751fb270a41019ce507d4099e + run_started_at: '2020-01-22T19:33:08Z' + triggering_actor: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + jobs_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs + logs_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs + check_suite_url: https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374 + artifacts_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts + cancel_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel + rerun_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun + previous_attempt_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/attempts/1 + workflow_url: https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038 + head_commit: + id: acb5820ced9479c074f688cc328bf03f341a511d + tree_id: d23f6eedb1e1b9610bbc754ddb5197bfe7271223 + message: Create linter.yaml + timestamp: '2020-01-22T19:33:05Z' + author: + name: Octo Cat + email: octocat@github.com + committer: + name: GitHub + email: noreply@github.com + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + head_repository: + id: 217723378 + node_id: MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg= + name: octo-repo + full_name: octo-org/octo-repo + private: true + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + html_url: https://github.com/octo-org/octo-repo + description: + fork: false + url: https://api.github.com/repos/octo-org/octo-repo + forks_url: https://api.github.com/repos/octo-org/octo-repo/forks + keys_url: https://api.github.com/repos/octo-org/octo-repo/keys{/key_id} + collaborators_url: https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator} + teams_url: https://api.github.com/repos/octo-org/octo-repo/teams + hooks_url: https://api.github.com/repos/octo-org/octo-repo/hooks + issue_events_url: https://api.github.com/repos/octo-org/octo-repo/issues/events{/number} + events_url: https://api.github.com/repos/octo-org/octo-repo/events + assignees_url: https://api.github.com/repos/octo-org/octo-repo/assignees{/user} + branches_url: https://api.github.com/repos/octo-org/octo-repo/branches{/branch} + tags_url: https://api.github.com/repos/octo-org/octo-repo/tags + blobs_url: https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha} + git_tags_url: https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha} + git_refs_url: https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha} + trees_url: https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha} + statuses_url: https://api.github.com/repos/octo-org/octo-repo/statuses/{sha} + languages_url: https://api.github.com/repos/octo-org/octo-repo/languages + stargazers_url: https://api.github.com/repos/octo-org/octo-repo/stargazers + contributors_url: https://api.github.com/repos/octo-org/octo-repo/contributors + subscribers_url: https://api.github.com/repos/octo-org/octo-repo/subscribers + subscription_url: https://api.github.com/repos/octo-org/octo-repo/subscription + commits_url: https://api.github.com/repos/octo-org/octo-repo/commits{/sha} + git_commits_url: https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha} + comments_url: https://api.github.com/repos/octo-org/octo-repo/comments{/number} + issue_comment_url: https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number} + contents_url: https://api.github.com/repos/octo-org/octo-repo/contents/{+path} + compare_url: https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head} + merges_url: https://api.github.com/repos/octo-org/octo-repo/merges + archive_url: https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref} + downloads_url: https://api.github.com/repos/octo-org/octo-repo/downloads + issues_url: https://api.github.com/repos/octo-org/octo-repo/issues{/number} + pulls_url: https://api.github.com/repos/octo-org/octo-repo/pulls{/number} + milestones_url: https://api.github.com/repos/octo-org/octo-repo/milestones{/number} + notifications_url: https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating} + labels_url: https://api.github.com/repos/octo-org/octo-repo/labels{/name} + releases_url: https://api.github.com/repos/octo-org/octo-repo/releases{/id} + deployments_url: https://api.github.com/repos/octo-org/octo-repo/deployments + environment-approvals-items: + value: + - state: approved + comment: Ship it! + environments: + - id: 161088068 + node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 + name: staging + url: https://api.github.com/repos/github/hello-world/environments/staging + html_url: https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging + created_at: '2020-11-23T22:00:40Z' + updated_at: '2020-11-23T22:00:40Z' + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + job-paginated: + value: + total_count: 1 + jobs: + - id: 399444496 + run_id: 29679449 + run_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449 + node_id: MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng== + head_sha: f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0 + url: https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496 + html_url: https://github.com/octo-org/octo-repo/runs/399444496 + status: completed + conclusion: success + started_at: '2020-01-20T17:42:40Z' + completed_at: '2020-01-20T17:44:39Z' + name: build + steps: + - name: Set up job + status: completed + conclusion: success + number: 1 + started_at: '2020-01-20T09:42:40.000-08:00' + completed_at: '2020-01-20T09:42:41.000-08:00' + - name: Run actions/checkout@v2 + status: completed + conclusion: success + number: 2 + started_at: '2020-01-20T09:42:41.000-08:00' + completed_at: '2020-01-20T09:42:45.000-08:00' + - name: Set up Ruby + status: completed + conclusion: success + number: 3 + started_at: '2020-01-20T09:42:45.000-08:00' + completed_at: '2020-01-20T09:42:45.000-08:00' + - name: Run actions/cache@v3 + status: completed + conclusion: success + number: 4 + started_at: '2020-01-20T09:42:45.000-08:00' + completed_at: '2020-01-20T09:42:48.000-08:00' + - name: Install Bundler + status: completed + conclusion: success + number: 5 + started_at: '2020-01-20T09:42:48.000-08:00' + completed_at: '2020-01-20T09:42:52.000-08:00' + - name: Install Gems + status: completed + conclusion: success + number: 6 + started_at: '2020-01-20T09:42:52.000-08:00' + completed_at: '2020-01-20T09:42:53.000-08:00' + - name: Run Tests + status: completed + conclusion: success + number: 7 + started_at: '2020-01-20T09:42:53.000-08:00' + completed_at: '2020-01-20T09:42:59.000-08:00' + - name: Deploy to Heroku + status: completed + conclusion: success + number: 8 + started_at: '2020-01-20T09:42:59.000-08:00' + completed_at: '2020-01-20T09:44:39.000-08:00' + - name: Post actions/cache@v3 + status: completed + conclusion: success + number: 16 + started_at: '2020-01-20T09:44:39.000-08:00' + completed_at: '2020-01-20T09:44:39.000-08:00' + - name: Complete job + status: completed + conclusion: success + number: 17 + started_at: '2020-01-20T09:44:39.000-08:00' + completed_at: '2020-01-20T09:44:39.000-08:00' + check_run_url: https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496 + labels: + - self-hosted + - foo + - bar + runner_id: 1 + runner_name: my runner + runner_group_id: 2 + runner_group_name: my runner group + pending-deployment-items: + value: + - environment: + id: 161088068 + node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 + name: staging + url: https://api.github.com/repos/github/hello-world/environments/staging + html_url: https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging + wait_timer: 30 + wait_timer_started_at: '2020-11-23T22:00:40Z' + current_user_can_approve: true + reviewers: + - type: User + reviewer: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + - type: Team + reviewer: + id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: + deployment-items: + value: + - url: https://api.github.com/repos/octocat/example/deployments/1 + id: 1 + node_id: MDEwOkRlcGxveW1lbnQx + sha: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + ref: topic-branch + task: deploy + payload: {} + original_environment: staging + environment: production + description: Deploy request from hubot + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2012-07-20T01:19:13Z' + updated_at: '2012-07-20T01:19:13Z' + statuses_url: https://api.github.com/repos/octocat/example/deployments/1/statuses + repository_url: https://api.github.com/repos/octocat/example + transient_environment: false + production_environment: true + workflow-run-usage: + value: + billable: + UBUNTU: + total_ms: 180000 + jobs: 1 + job_runs: + - job_id: 1 + duration_ms: 180000 + MACOS: + total_ms: 240000 + jobs: 4 + job_runs: + - job_id: 2 + duration_ms: 60000 + - job_id: 3 + duration_ms: 60000 + - job_id: 4 + duration_ms: 60000 + - job_id: 5 + duration_ms: 60000 + WINDOWS: + total_ms: 300000 + jobs: 2 + job_runs: + - job_id: 6 + duration_ms: 150000 + - job_id: 7 + duration_ms: 150000 + run_duration_ms: 500000 + actions-secret-paginated: + value: + total_count: 2 + secrets: + - name: GH_TOKEN + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + - name: GIST_ID + created_at: '2020-01-10T10:59:22Z' + updated_at: '2020-01-11T11:59:22Z' + actions-secret: + value: + name: GH_TOKEN + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + workflow-paginated: + value: + total_count: 2 + workflows: + - id: 161335 + node_id: MDg6V29ya2Zsb3cxNjEzMzU= + name: CI + path: ".github/workflows/blank.yaml" + state: active + created_at: '2020-01-08T23:48:37.000-08:00' + updated_at: '2020-01-08T23:50:21.000-08:00' + url: https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335 + html_url: https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335 + badge_url: https://github.com/octo-org/octo-repo/workflows/CI/badge.svg + - id: 269289 + node_id: MDE4OldvcmtmbG93IFNlY29uZGFyeTI2OTI4OQ== + name: Linter + path: ".github/workflows/linter.yaml" + state: active + created_at: '2020-01-08T23:48:37.000-08:00' + updated_at: '2020-01-08T23:50:21.000-08:00' + url: https://api.github.com/repos/octo-org/octo-repo/actions/workflows/269289 + html_url: https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289 + badge_url: https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg + workflow: + value: + id: 161335 + node_id: MDg6V29ya2Zsb3cxNjEzMzU= + name: CI + path: ".github/workflows/blank.yaml" + state: active + created_at: '2020-01-08T23:48:37.000-08:00' + updated_at: '2020-01-08T23:50:21.000-08:00' + url: https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335 + html_url: https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335 + badge_url: https://github.com/octo-org/octo-repo/workflows/CI/badge.svg + workflow-usage: + value: + billable: + UBUNTU: + total_ms: 180000 + MACOS: + total_ms: 240000 + WINDOWS: + total_ms: 300000 + autolink-items: + value: + - id: 1 + key_prefix: TICKET- + url_template: https://example.com/TICKET?query=Hi! This is an area for us to collaborate as a team
" + body_version: + description: The current version of the body content. If provided, this + update operation will be rejected if the given version does not match + the latest version on the server. + example: 0307116bbf7ced493b8d8a346c650b71 + type: string + comments_count: + type: integer + example: 0 + comments_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/2343027/discussions/1/comments + created_at: + type: string + format: date-time + example: '2018-01-25T18:56:31Z' + last_edited_at: + type: string + format: date-time + nullable: true + html_url: + type: string + format: uri + example: https://github.com/orgs/github/teams/justice-league/discussions/1 + node_id: + type: string + example: MDE0OlRlYW1EaXNjdXNzaW9uMQ== + number: + description: The unique sequence number of a team discussion. + example: 42 + type: integer + pinned: + description: Whether or not this discussion should be pinned for easy retrieval. + example: true + type: boolean + private: + description: Whether or not this discussion should be restricted to team + members and organization administrators. + example: true + type: boolean + team_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/2343027 + title: + description: The title of the discussion. + example: How can we improve our workflow? + type: string + updated_at: + type: string + format: date-time + example: '2018-01-25T18:56:31Z' + url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/2343027/discussions/1 + reactions: + "$ref": "#/components/schemas/reaction-rollup" + required: + - author + - body + - body_html + - body_version + - comments_count + - comments_url + - created_at + - last_edited_at + - html_url + - pinned + - private + - node_id + - number + - team_url + - title + - updated_at + - url + team-discussion-comment: + title: Team Discussion Comment + description: A reply to a discussion within a team. + type: object + properties: + author: + "$ref": "#/components/schemas/nullable-simple-user" + body: + description: The main text of the comment. + example: I agree with this suggestion. + type: string + body_html: + type: string + example: "Do you like apples?
" + body_version: + description: The current version of the body content. If provided, this + update operation will be rejected if the given version does not match + the latest version on the server. + example: 0307116bbf7ced493b8d8a346c650b71 + type: string + created_at: + type: string + format: date-time + example: '2018-01-15T23:53:58Z' + last_edited_at: + type: string + format: date-time + nullable: true + discussion_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/2403582/discussions/1 + html_url: + type: string + format: uri + example: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + node_id: + type: string + example: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= + number: + description: The unique sequence number of a team discussion comment. + example: 42 + type: integer + updated_at: + type: string + format: date-time + example: '2018-01-15T23:53:58Z' + url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 + reactions: + "$ref": "#/components/schemas/reaction-rollup" + required: + - author + - body + - body_html + - body_version + - created_at + - last_edited_at + - discussion_url + - html_url + - node_id + - number + - updated_at + - url + reaction: + title: Reaction + description: Reactions to conversations provide a way to help people express + their feelings more simply and effectively. + type: object + properties: + id: + type: integer + example: 1 + node_id: + type: string + example: MDg6UmVhY3Rpb24x + user: + "$ref": "#/components/schemas/nullable-simple-user" + content: + description: The reaction to use + example: heart + type: string + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes + created_at: + type: string + format: date-time + example: '2016-05-20T20:09:31Z' + required: + - id + - node_id + - user + - content + - created_at + team-membership: + title: Team Membership + description: Team Membership + type: object + properties: + url: + type: string + format: uri + role: + description: The role of the user in the team. + enum: + - member + - maintainer + default: member + example: member + type: string + state: + description: The state of the user's membership in the team. + type: string + enum: + - active + - pending + required: + - role + - state + - url + team-project: + title: Team Project + description: A team's access to a project. + type: object + properties: + owner_url: + type: string + url: + type: string + html_url: + type: string + columns_url: + type: string + id: + type: integer + node_id: + type: string + name: + type: string + body: + type: string + nullable: true + number: + type: integer + state: + type: string + creator: + "$ref": "#/components/schemas/simple-user" + created_at: + type: string + updated_at: + type: string + organization_permission: + description: The organization permission for this project. Only present + when owner is an organization. + type: string + private: + description: Whether the project is private or not. Only present when owner + is an organization. + type: boolean + permissions: + type: object + properties: + read: + type: boolean + write: + type: boolean + admin: + type: boolean + required: + - read + - write + - admin + required: + - owner_url + - url + - html_url + - columns_url + - id + - node_id + - name + - body + - number + - state + - creator + - created_at + - updated_at + - permissions + nullable-repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + "$ref": "#/components/schemas/nullable-license-simple" + organization: + "$ref": "#/components/schemas/nullable-simple-user" + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + "$ref": "#/components/schemas/simple-user" + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: The size of the repository. Size is calculated hourly. When + a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: Whether this repository acts as a template that can be used + to generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + template_repository: + nullable: true + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + full_name: + type: string + owner: + type: object + properties: + login: + type: string + id: + type: integer + node_id: + type: string + avatar_url: + type: string + gravatar_id: + type: string + url: + type: string + html_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + starred_url: + type: string + subscriptions_url: + type: string + organizations_url: + type: string + repos_url: + type: string + events_url: + type: string + received_events_url: + type: string + type: + type: string + site_admin: + type: boolean + private: + type: boolean + html_url: + type: string + description: + type: string + fork: + type: boolean + url: + type: string + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + downloads_url: + type: string + events_url: + type: string + forks_url: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + git_url: + type: string + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + notifications_url: + type: string + pulls_url: + type: string + releases_url: + type: string + ssh_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + clone_url: + type: string + mirror_url: + type: string + hooks_url: + type: string + svn_url: + type: string + homepage: + type: string + language: + type: string + forks_count: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + size: + type: integer + default_branch: + type: string + open_issues_count: + type: integer + is_template: + type: boolean + topics: + type: array + items: + type: string + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_downloads: + type: boolean + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: string + created_at: + type: string + updated_at: + type: string + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + allow_rebase_merge: + type: boolean + temp_clone_token: + type: string + allow_squash_merge: + type: boolean + allow_auto_merge: + type: boolean + delete_branch_on_merge: + type: boolean + allow_update_branch: + type: boolean + use_squash_pr_title_as_default: + type: boolean + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: Whether or not a pull request head branch that is behind its + base branch can always be updated even if it is not required to be up + to date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: Whether a squash merge commit can use the pull request title + as default. **This property has been deprecated. Please use `squash_merge_commit_title` + instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + nullable: true + team-repository: + title: Team Repository + description: A team's access to a repository. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + "$ref": "#/components/schemas/nullable-license-simple" + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + role_name: + type: string + example: admin + owner: + "$ref": "#/components/schemas/nullable-simple-user" + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: Whether this repository acts as a template that can be used + to generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + template_repository: + "$ref": "#/components/schemas/nullable-repository" + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + default: false + type: boolean + example: false + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + example: false + subscribers_count: + type: integer + network_count: + type: integer + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + project-card: + title: Project Card + description: Project cards represent a scope of work. + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/projects/columns/cards/1478 + id: + description: The project card's ID + example: 42 + type: integer + node_id: + type: string + example: MDExOlByb2plY3RDYXJkMTQ3OA== + note: + type: string + example: Add payload for delete Project column + nullable: true + creator: + "$ref": "#/components/schemas/nullable-simple-user" + created_at: + type: string + format: date-time + example: '2016-09-05T14:21:06Z' + updated_at: + type: string + format: date-time + example: '2016-09-05T14:20:22Z' + archived: + description: Whether or not the card is archived + example: false + type: boolean + column_name: + type: string + project_id: + type: string + column_url: + type: string + format: uri + example: https://api.github.com/projects/columns/367 + content_url: + type: string + format: uri + example: https://api.github.com/repos/api-playground/projects-test/issues/3 + project_url: + type: string + format: uri + example: https://api.github.com/projects/120 + required: + - id + - node_id + - note + - url + - column_url + - project_url + - creator + - created_at + - updated_at + project-column: + title: Project Column + description: Project columns contain cards of work. + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/projects/columns/367 + project_url: + type: string + format: uri + example: https://api.github.com/projects/120 + cards_url: + type: string + format: uri + example: https://api.github.com/projects/columns/367/cards + id: + description: The unique identifier of the project column + example: 42 + type: integer + node_id: + type: string + example: MDEzOlByb2plY3RDb2x1bW4zNjc= + name: + description: Name of the project column + example: Remaining tasks + type: string + created_at: + type: string + format: date-time + example: '2016-09-05T14:18:44Z' + updated_at: + type: string + format: date-time + example: '2016-09-05T14:22:28Z' + required: + - id + - node_id + - url + - project_url + - cards_url + - name + - created_at + - updated_at + project-collaborator-permission: + title: Project Collaborator Permission + description: Project Collaborator Permission + type: object + properties: + permission: + type: string + user: + "$ref": "#/components/schemas/nullable-simple-user" + required: + - permission + - user + rate-limit: + title: Rate Limit + type: object + properties: + limit: + type: integer + remaining: + type: integer + reset: + type: integer + used: + type: integer + required: + - limit + - remaining + - reset + - used + rate-limit-overview: + title: Rate Limit Overview + description: Rate Limit Overview + type: object + properties: + resources: + type: object + properties: + core: + "$ref": "#/components/schemas/rate-limit" + graphql: + "$ref": "#/components/schemas/rate-limit" + search: + "$ref": "#/components/schemas/rate-limit" + source_import: + "$ref": "#/components/schemas/rate-limit" + integration_manifest: + "$ref": "#/components/schemas/rate-limit" + code_scanning_upload: + "$ref": "#/components/schemas/rate-limit" + actions_runner_registration: + "$ref": "#/components/schemas/rate-limit" + scim: + "$ref": "#/components/schemas/rate-limit" + dependency_snapshots: + "$ref": "#/components/schemas/rate-limit" + required: + - core + - search + rate: + "$ref": "#/components/schemas/rate-limit" + required: + - rate + - resources + code-of-conduct-simple: + title: Code Of Conduct Simple + description: Code of Conduct Simple + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/github/docs/community/code_of_conduct + key: + type: string + example: citizen_code_of_conduct + name: + type: string + example: Citizen Code of Conduct + html_url: + type: string + nullable: true + format: uri + example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md + required: + - url + - key + - name + - html_url + security-and-analysis: + nullable: true + type: object + properties: + advanced_security: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_push_protection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + full-repository: + title: Full Repository + description: Full Repository + type: object + properties: + id: + type: integer + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + "$ref": "#/components/schemas/simple-user" + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: The size of the repository. Size is calculated hourly. When + a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + type: boolean + example: true + topics: + type: array + items: + type: string + example: + - octocat + - atom + - electron + - API + has_issues: + type: boolean + example: true + has_projects: + type: boolean + example: true + has_wiki: + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + type: boolean + example: true + has_discussions: + type: boolean + example: true + archived: + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + type: string + example: public + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + required: + - admin + - pull + - push + allow_rebase_merge: + type: boolean + example: true + template_repository: + "$ref": "#/components/schemas/nullable-repository" + temp_clone_token: + type: string + nullable: true + allow_squash_merge: + type: boolean + example: true + allow_auto_merge: + type: boolean + example: false + delete_branch_on_merge: + type: boolean + example: false + allow_merge_commit: + type: boolean + example: true + allow_update_branch: + type: boolean + example: true + use_squash_pr_title_as_default: + type: boolean + example: false + squash_merge_commit_title: + type: string + example: PR_TITLE + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + example: PR_BODY + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + example: PR_TITLE + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + example: PR_BODY + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_forking: + type: boolean + example: true + web_commit_signoff_required: + type: boolean + example: false + subscribers_count: + type: integer + example: 42 + network_count: + type: integer + example: 0 + license: + "$ref": "#/components/schemas/nullable-license-simple" + organization: + "$ref": "#/components/schemas/nullable-simple-user" + parent: + "$ref": "#/components/schemas/repository" + source: + "$ref": "#/components/schemas/repository" + forks: + type: integer + master_branch: + type: string + open_issues: + type: integer + watchers: + type: integer + anonymous_access_enabled: + description: Whether anonymous git access is allowed. + default: true + type: boolean + code_of_conduct: + "$ref": "#/components/schemas/code-of-conduct-simple" + security_and_analysis: + "$ref": "#/components/schemas/security-and-analysis" + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - has_discussions + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + - network_count + - subscribers_count + artifact: + title: Artifact + description: An artifact + type: object + properties: + id: + type: integer + example: 5 + node_id: + type: string + example: MDEwOkNoZWNrU3VpdGU1 + name: + description: The name of the artifact. + type: string + example: AdventureWorks.Framework + size_in_bytes: + description: The size in bytes of the artifact. + type: integer + example: 12345 + url: + type: string + example: https://api.github.com/repos/github/hello-world/actions/artifacts/5 + archive_download_url: + type: string + example: https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip + expired: + description: Whether or not the artifact has expired. + type: boolean + created_at: + type: string + format: date-time + nullable: true + expires_at: + type: string + format: date-time + nullable: true + updated_at: + type: string + format: date-time + nullable: true + workflow_run: + type: object + nullable: true + properties: + id: + example: 10 + type: integer + repository_id: + example: 42 + type: integer + head_repository_id: + example: 42 + type: integer + head_branch: + example: main + type: string + head_sha: + example: '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' + type: string + required: + - id + - node_id + - name + - size_in_bytes + - url + - archive_download_url + - expired + - created_at + - expires_at + - updated_at + actions-cache-list: + title: Repository actions caches + description: Repository actions caches + type: object + properties: + total_count: + description: Total number of caches + type: integer + example: 2 + actions_caches: + description: Array of caches + type: array + items: + type: object + properties: + id: + type: integer + example: 2 + ref: + type: string + example: refs/heads/main + key: + type: string + example: Linux-node-958aff96db2d75d67787d1e634ae70b659de937b + version: + type: string + example: 73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0 + last_accessed_at: + type: string + format: date-time + example: '2019-01-24T22:45:36.000Z' + created_at: + type: string + format: date-time + example: '2019-01-24T22:45:36.000Z' + size_in_bytes: + type: integer + example: 1024 + required: + - total_count + - actions_caches + job: + title: Job + description: Information of a job execution in a workflow run + type: object + properties: + id: + description: The id of the job. + example: 21 + type: integer + run_id: + description: The id of the associated workflow run. + example: 5 + type: integer + run_url: + type: string + example: https://api.github.com/repos/github/hello-world/actions/runs/5 + run_attempt: + type: integer + description: Attempt number of the associated workflow run, 1 for first + attempt and higher if the workflow was re-run. + example: 1 + node_id: + type: string + example: MDg6Q2hlY2tSdW40 + head_sha: + description: The SHA of the commit that is being run. + example: '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' + type: string + url: + type: string + example: https://api.github.com/repos/github/hello-world/actions/jobs/21 + html_url: + type: string + example: https://github.com/github/hello-world/runs/4 + nullable: true + status: + description: The phase of the lifecycle that the job is currently in. + example: queued + type: string + enum: + - queued + - in_progress + - completed + conclusion: + description: The outcome of the job. + example: success + type: string + nullable: true + enum: + - success + - failure + - neutral + - cancelled + - skipped + - timed_out + - action_required + started_at: + description: The time that the job started, in ISO 8601 format. + example: '2019-08-08T08:00:00-07:00' + format: date-time + type: string + completed_at: + description: The time that the job finished, in ISO 8601 format. + example: '2019-08-08T08:00:00-07:00' + format: date-time + type: string + nullable: true + name: + description: The name of the job. + example: test-coverage + type: string + steps: + description: Steps in this job. + type: array + items: + type: object + required: + - name + - status + - conclusion + - number + properties: + status: + description: The phase of the lifecycle that the job is currently + in. + example: queued + type: string + enum: + - queued + - in_progress + - completed + conclusion: + description: The outcome of the job. + example: success + type: string + nullable: true + name: + description: The name of the job. + example: test-coverage + type: string + number: + type: integer + example: 1 + started_at: + description: The time that the step started, in ISO 8601 format. + example: '2019-08-08T08:00:00-07:00' + format: date-time + type: string + nullable: true + completed_at: + description: The time that the job finished, in ISO 8601 format. + example: '2019-08-08T08:00:00-07:00' + format: date-time + type: string + nullable: true + check_run_url: + type: string + example: https://api.github.com/repos/github/hello-world/check-runs/4 + labels: + type: array + items: + type: string + description: Labels for the workflow job. Specified by the "runs_on" attribute + in the action's workflow file. + example: + - self-hosted + - foo + - bar + runner_id: + type: integer + nullable: true + example: 1 + description: The ID of the runner to which this job has been assigned. (If + a runner hasn't yet been assigned, this will be null.) + runner_name: + type: string + nullable: true + example: my runner + description: The name of the runner to which this job has been assigned. + (If a runner hasn't yet been assigned, this will be null.) + runner_group_id: + type: integer + nullable: true + example: 2 + description: The ID of the runner group to which this job has been assigned. + (If a runner hasn't yet been assigned, this will be null.) + runner_group_name: + type: string + nullable: true + example: my runner group + description: The name of the runner group to which this job has been assigned. + (If a runner hasn't yet been assigned, this will be null.) + required: + - id + - node_id + - run_id + - run_url + - head_sha + - name + - url + - html_url + - status + - conclusion + - started_at + - completed_at + - check_run_url + - labels + - runner_id + - runner_name + - runner_group_id + - runner_group_name + actions-enabled: + type: boolean + description: Whether GitHub Actions is enabled on the repository. + actions-repository-permissions: + type: object + properties: + enabled: + "$ref": "#/components/schemas/actions-enabled" + allowed_actions: + "$ref": "#/components/schemas/allowed-actions" + selected_actions_url: + "$ref": "#/components/schemas/selected-actions-url" + required: + - enabled + actions-workflow-access-to-repository: + type: object + properties: + access_level: + type: string + description: |- + Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the + repository. `none` means access is only possible from workflows in this repository. + enum: + - none + - organization + - enterprise + required: + - access_level + referenced-workflow: + title: Referenced workflow + description: A workflow referenced/reused by the initial caller workflow + type: object + properties: + path: + type: string + sha: + type: string + ref: + type: string + required: + - path + - sha + pull-request-minimal: + title: Pull Request Minimal + type: object + properties: + id: + type: integer + number: + type: integer + url: + type: string + head: + type: object + properties: + ref: + type: string + sha: + type: string + repo: + type: object + properties: + id: + type: integer + url: + type: string + name: + type: string + required: + - id + - url + - name + required: + - ref + - sha + - repo + base: + type: object + properties: + ref: + type: string + sha: + type: string + repo: + type: object + properties: + id: + type: integer + url: + type: string + name: + type: string + required: + - id + - url + - name + required: + - ref + - sha + - repo + required: + - id + - number + - url + - head + - base + nullable-simple-commit: + title: Simple Commit + description: A commit. + type: object + properties: + id: + type: string + tree_id: + type: string + message: + type: string + timestamp: + type: string + format: date-time + author: + type: object + properties: + name: + type: string + email: + type: string + required: + - name + - email + nullable: true + committer: + type: object + properties: + name: + type: string + email: + type: string + required: + - name + - email + nullable: true + required: + - id + - tree_id + - message + - timestamp + - author + - committer + nullable: true + workflow-run: + title: Workflow Run + description: An invocation of a workflow + type: object + properties: + id: + type: integer + description: The ID of the workflow run. + example: 5 + name: + type: string + description: The name of the workflow run. + nullable: true + example: Build + node_id: + type: string + example: MDEwOkNoZWNrU3VpdGU1 + check_suite_id: + type: integer + description: The ID of the associated check suite. + example: 42 + check_suite_node_id: + type: string + description: The node ID of the associated check suite. + example: MDEwOkNoZWNrU3VpdGU0Mg== + head_branch: + type: string + nullable: true + example: master + head_sha: + description: The SHA of the head commit that points to the version of the + workflow being run. + example: '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' + type: string + path: + description: The full path of the workflow + example: octocat/octo-repo/.github/workflows/ci.yml@main + type: string + run_number: + type: integer + description: The auto incrementing run number for the workflow run. + example: 106 + run_attempt: + type: integer + description: Attempt number of the run, 1 for first attempt and higher if + the workflow was re-run. + example: 1 + referenced_workflows: + type: array + nullable: true + items: + "$ref": "#/components/schemas/referenced-workflow" + event: + type: string + example: push + status: + type: string + nullable: true + example: completed + conclusion: + type: string + nullable: true + example: neutral + workflow_id: + type: integer + description: The ID of the parent workflow. + example: 5 + url: + type: string + description: The URL to the workflow run. + example: https://api.github.com/repos/github/hello-world/actions/runs/5 + html_url: + type: string + example: https://github.com/github/hello-world/suites/4 + pull_requests: + type: array + nullable: true + items: + "$ref": "#/components/schemas/pull-request-minimal" + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + actor: + "$ref": "#/components/schemas/simple-user" + triggering_actor: + "$ref": "#/components/schemas/simple-user" + run_started_at: + type: string + format: date-time + description: The start time of the latest run. Resets on re-run. + jobs_url: + description: The URL to the jobs for the workflow run. + type: string + example: https://api.github.com/repos/github/hello-world/actions/runs/5/jobs + logs_url: + description: The URL to download the logs for the workflow run. + type: string + example: https://api.github.com/repos/github/hello-world/actions/runs/5/logs + check_suite_url: + description: The URL to the associated check suite. + type: string + example: https://api.github.com/repos/github/hello-world/check-suites/12 + artifacts_url: + description: The URL to the artifacts for the workflow run. + type: string + example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts + cancel_url: + description: The URL to cancel the workflow run. + type: string + example: https://api.github.com/repos/github/hello-world/actions/runs/5/cancel + rerun_url: + description: The URL to rerun the workflow run. + type: string + example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun + previous_attempt_url: + nullable: true + description: The URL to the previous attempted run of this workflow, if + one exists. + type: string + example: https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 + workflow_url: + description: The URL to the workflow. + type: string + example: https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml + head_commit: + "$ref": "#/components/schemas/nullable-simple-commit" + repository: + "$ref": "#/components/schemas/minimal-repository" + head_repository: + "$ref": "#/components/schemas/minimal-repository" + head_repository_id: + type: integer + example: 5 + display_title: + type: string + example: Simple Workflow + description: The event-specific title associated with the run or the run-name + if set, or the value of `run-name` if it is set in the workflow. + required: + - id + - node_id + - head_branch + - run_number + - display_title + - event + - status + - conclusion + - head_sha + - path + - workflow_id + - url + - html_url + - created_at + - updated_at + - head_commit + - head_repository + - repository + - jobs_url + - logs_url + - check_suite_url + - cancel_url + - rerun_url + - artifacts_url + - workflow_url + - pull_requests + environment-approvals: + title: Environment Approval + description: An entry in the reviews log for environment deployments + type: object + properties: + environments: + description: The list of environments that were approved or rejected + type: array + items: + type: object + properties: + id: + description: The id of the environment. + example: 56780428 + type: integer + node_id: + type: string + example: MDExOkVudmlyb25tZW50NTY3ODA0Mjg= + name: + description: The name of the environment. + example: staging + type: string + url: + type: string + example: https://api.github.com/repos/github/hello-world/environments/staging + html_url: + type: string + example: https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging + created_at: + description: The time that the environment was created, in ISO 8601 + format. + example: '2020-11-23T22:00:40Z' + format: date-time + type: string + updated_at: + description: The time that the environment was last updated, in ISO + 8601 format. + example: '2020-11-23T22:00:40Z' + format: date-time + type: string + state: + description: Whether deployment to the environment(s) was approved or rejected + enum: + - approved + - rejected + example: approved + type: string + user: + "$ref": "#/components/schemas/simple-user" + comment: + type: string + description: The comment submitted with the deployment review + example: Ship it! + required: + - environments + - state + - user + - comment + deployment-reviewer-type: + type: string + description: The type of reviewer. + enum: + - User + - Team + example: User + pending-deployment: + title: Pending Deployment + description: Details of a deployment that is waiting for protection rules to + pass + type: object + properties: + environment: + type: object + properties: + id: + description: The id of the environment. + example: 56780428 + type: integer + node_id: + type: string + example: MDExOkVudmlyb25tZW50NTY3ODA0Mjg= + name: + description: The name of the environment. + example: staging + type: string + url: + type: string + example: https://api.github.com/repos/github/hello-world/environments/staging + html_url: + type: string + example: https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging + wait_timer: + type: integer + description: The set duration of the wait timer + example: 30 + wait_timer_started_at: + description: The time that the wait timer began. + example: '2020-11-23T22:00:40Z' + format: date-time + type: string + nullable: true + current_user_can_approve: + description: Whether the currently authenticated user can approve the deployment + type: boolean + example: true + reviewers: + type: array + description: The people or teams that may approve jobs that reference the + environment. You can list up to six users or teams as reviewers. The reviewers + must have at least read access to the repository. Only one of the required + reviewers needs to approve the job for it to proceed. + items: + type: object + properties: + type: + "$ref": "#/components/schemas/deployment-reviewer-type" + reviewer: + anyOf: + - "$ref": "#/components/schemas/simple-user" + - "$ref": "#/components/schemas/team" + required: + - environment + - wait_timer + - wait_timer_started_at + - current_user_can_approve + - reviewers + deployment: + title: Deployment + description: A request for a specific ref(branch,sha,tag) to be deployed + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example/deployments/1 + id: + description: Unique identifier of the deployment + example: 42 + type: integer + node_id: + type: string + example: MDEwOkRlcGxveW1lbnQx + sha: + type: string + example: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + ref: + description: The ref to deploy. This can be a branch, tag, or sha. + example: topic-branch + type: string + task: + description: Parameter to specify a task to execute + example: deploy + type: string + payload: + oneOf: + - type: object + additionalProperties: true + - type: string + original_environment: + type: string + example: staging + environment: + description: Name for the target deployment environment. + example: production + type: string + description: + type: string + example: Deploy request from hubot + nullable: true + creator: + "$ref": "#/components/schemas/nullable-simple-user" + created_at: + type: string + format: date-time + example: '2012-07-20T01:19:13Z' + updated_at: + type: string + format: date-time + example: '2012-07-20T01:19:13Z' + statuses_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example/deployments/1/statuses + repository_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example + transient_environment: + description: 'Specifies if the given environment is will no longer exist + at some point in the future. Default: false.' + example: true + type: boolean + production_environment: + description: 'Specifies if the given environment is one that end-users directly + interact with. Default: false.' + example: true + type: boolean + performed_via_github_app: + "$ref": "#/components/schemas/nullable-integration" + required: + - id + - node_id + - sha + - ref + - task + - environment + - creator + - payload + - description + - statuses_url + - repository_url + - url + - created_at + - updated_at + workflow-run-usage: + title: Workflow Run Usage + description: Workflow Run Usage + type: object + properties: + billable: + type: object + properties: + UBUNTU: + type: object + required: + - total_ms + - jobs + properties: + total_ms: + type: integer + jobs: + type: integer + job_runs: + type: array + items: + type: object + required: + - job_id + - duration_ms + properties: + job_id: + type: integer + duration_ms: + type: integer + MACOS: + type: object + required: + - total_ms + - jobs + properties: + total_ms: + type: integer + jobs: + type: integer + job_runs: + type: array + items: + type: object + required: + - job_id + - duration_ms + properties: + job_id: + type: integer + duration_ms: + type: integer + WINDOWS: + type: object + required: + - total_ms + - jobs + properties: + total_ms: + type: integer + jobs: + type: integer + job_runs: + type: array + items: + type: object + required: + - job_id + - duration_ms + properties: + job_id: + type: integer + duration_ms: + type: integer + run_duration_ms: + type: integer + required: + - billable + actions-secret: + title: Actions Secret + description: Set secrets for GitHub Actions. + type: object + properties: + name: + description: The name of the secret. + example: SECRET_TOKEN + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - name + - created_at + - updated_at + workflow: + title: Workflow + description: A GitHub Actions workflow + type: object + properties: + id: + type: integer + example: 5 + node_id: + type: string + example: MDg6V29ya2Zsb3cxMg== + name: + type: string + example: CI + path: + type: string + example: ruby.yaml + state: + type: string + example: active + enum: + - active + - deleted + - disabled_fork + - disabled_inactivity + - disabled_manually + created_at: + type: string + format: date-time + example: '2019-12-06T14:20:20.000Z' + updated_at: + type: string + format: date-time + example: '2019-12-06T14:20:20.000Z' + url: + type: string + example: https://api.github.com/repos/actions/setup-ruby/workflows/5 + html_url: + type: string + example: https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml + badge_url: + type: string + example: https://github.com/actions/setup-ruby/workflows/CI/badge.svg + deleted_at: + type: string + format: date-time + example: '2019-12-06T14:20:20.000Z' + required: + - id + - node_id + - name + - path + - state + - url + - html_url + - badge_url + - created_at + - updated_at + workflow-usage: + title: Workflow Usage + description: Workflow Usage + type: object + properties: + billable: + type: object + properties: + UBUNTU: + type: object + properties: + total_ms: + type: integer + MACOS: + type: object + properties: + total_ms: + type: integer + WINDOWS: + type: object + properties: + total_ms: + type: integer + required: + - billable + autolink: + title: Autolink reference + description: An autolink reference. + type: object + properties: + id: + type: integer + example: 3 + key_prefix: + description: The prefix of a key that is linkified. + example: TICKET- + type: string + url_template: + description: A template for the target URL that is generated if a key was + found. + example: https://example.com/TICKET?query=comment body
"' + body_text: + type: string + example: '"comment body"' + required: + - url + - id + - node_id + - pull_request_review_id + - diff_hunk + - path + - position + - original_position + - commit_id + - original_commit_id + - user + - body + - created_at + - updated_at + - html_url + - pull_request_url + - author_association + - _links + timeline-line-commented-event: + title: Timeline Line Commented Event + description: Timeline Line Commented Event + type: object + properties: + event: + type: string + node_id: + type: string + comments: + type: array + items: + "$ref": "#/components/schemas/pull-request-review-comment" + timeline-commit-commented-event: + title: Timeline Commit Commented Event + description: Timeline Commit Commented Event + type: object + properties: + event: + type: string + node_id: + type: string + commit_id: + type: string + comments: + type: array + items: + "$ref": "#/components/schemas/commit-comment" + timeline-assigned-issue-event: + title: Timeline Assigned Issue Event + description: Timeline Assigned Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + "$ref": "#/components/schemas/simple-user" + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + "$ref": "#/components/schemas/nullable-integration" + assignee: + "$ref": "#/components/schemas/simple-user" + required: + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + - assignee + timeline-unassigned-issue-event: + title: Timeline Unassigned Issue Event + description: Timeline Unassigned Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + "$ref": "#/components/schemas/simple-user" + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + "$ref": "#/components/schemas/nullable-integration" + assignee: + "$ref": "#/components/schemas/simple-user" + required: + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + - assignee + state-change-issue-event: + title: State Change Issue Event + description: State Change Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + "$ref": "#/components/schemas/simple-user" + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + "$ref": "#/components/schemas/nullable-integration" + state_reason: + type: string + nullable: true + required: + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + timeline-issue-events: + title: Timeline Event + description: Timeline Event + type: object + anyOf: + - "$ref": "#/components/schemas/labeled-issue-event" + - "$ref": "#/components/schemas/unlabeled-issue-event" + - "$ref": "#/components/schemas/milestoned-issue-event" + - "$ref": "#/components/schemas/demilestoned-issue-event" + - "$ref": "#/components/schemas/renamed-issue-event" + - "$ref": "#/components/schemas/review-requested-issue-event" + - "$ref": "#/components/schemas/review-request-removed-issue-event" + - "$ref": "#/components/schemas/review-dismissed-issue-event" + - "$ref": "#/components/schemas/locked-issue-event" + - "$ref": "#/components/schemas/added-to-project-issue-event" + - "$ref": "#/components/schemas/moved-column-in-project-issue-event" + - "$ref": "#/components/schemas/removed-from-project-issue-event" + - "$ref": "#/components/schemas/converted-note-to-issue-issue-event" + - "$ref": "#/components/schemas/timeline-comment-event" + - "$ref": "#/components/schemas/timeline-cross-referenced-event" + - "$ref": "#/components/schemas/timeline-committed-event" + - "$ref": "#/components/schemas/timeline-reviewed-event" + - "$ref": "#/components/schemas/timeline-line-commented-event" + - "$ref": "#/components/schemas/timeline-commit-commented-event" + - "$ref": "#/components/schemas/timeline-assigned-issue-event" + - "$ref": "#/components/schemas/timeline-unassigned-issue-event" + - "$ref": "#/components/schemas/state-change-issue-event" + deploy-key: + title: Deploy Key + description: An SSH key granting access to a single repository. + type: object + properties: + id: + type: integer + key: + type: string + url: + type: string + title: + type: string + verified: + type: boolean + created_at: + type: string + read_only: + type: boolean + added_by: + type: string + nullable: true + last_used: + type: string + nullable: true + required: + - id + - key + - url + - title + - verified + - created_at + - read_only + language: + title: Language + description: Language + type: object + additionalProperties: + type: integer + license-content: + title: License Content + description: License Content + type: object + properties: + name: + type: string + path: + type: string + sha: + type: string + size: + type: integer + url: + type: string + format: uri + html_url: + type: string + format: uri + nullable: true + git_url: + type: string + format: uri + nullable: true + download_url: + type: string + format: uri + nullable: true + type: + type: string + content: + type: string + encoding: + type: string + _links: + type: object + properties: + git: + type: string + format: uri + nullable: true + html: + type: string + format: uri + nullable: true + self: + type: string + format: uri + required: + - git + - html + - self + license: + "$ref": "#/components/schemas/nullable-license-simple" + required: + - _links + - git_url + - html_url + - download_url + - name + - path + - sha + - size + - type + - url + - content + - encoding + - license + merged-upstream: + title: Merged upstream + description: Results of a successful merge upstream request + type: object + properties: + message: + type: string + merge_type: + type: string + enum: + - merge + - fast-forward + - none + base_branch: + type: string + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: + type: integer + example: 1002604 + node_id: + type: string + example: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: + description: The number of the milestone. + type: integer + example: 42 + state: + description: The state of the milestone. + example: open + type: string + enum: + - open + - closed + default: open + title: + description: The title of the milestone. + example: v1.0 + type: string + description: + type: string + example: Tracking milestone for version 1.0 + nullable: true + creator: + "$ref": "#/components/schemas/nullable-simple-user" + open_issues: + type: integer + example: 4 + closed_issues: + type: integer + example: 8 + created_at: + type: string + format: date-time + example: '2011-04-10T20:09:31Z' + updated_at: + type: string + format: date-time + example: '2014-03-03T18:58:10Z' + closed_at: + type: string + format: date-time + example: '2013-02-12T13:22:01Z' + nullable: true + due_on: + type: string + format: date-time + example: '2012-10-09T23:39:01Z' + nullable: true + required: + - closed_issues + - creator + - description + - due_on + - closed_at + - id + - node_id + - labels_url + - html_url + - number + - open_issues + - state + - title + - url + - created_at + - updated_at + pages-source-hash: + title: Pages Source Hash + type: object + properties: + branch: + type: string + path: + type: string + required: + - branch + - path + pages-https-certificate: + title: Pages Https Certificate + type: object + properties: + state: + type: string + enum: + - new + - authorization_created + - authorization_pending + - authorized + - authorization_revoked + - issued + - uploaded + - approved + - errored + - bad_authz + - destroy_pending + - dns_changed + example: approved + description: + type: string + example: Certificate is approved + domains: + type: array + items: + type: string + description: Array of the domain set and its alternate name (if it is configured) + example: + - example.com + - www.example.com + expires_at: + type: string + format: date + required: + - state + - description + - domains + page: + title: GitHub Pages + description: The configuration for GitHub Pages for a repository. + type: object + properties: + url: + type: string + description: The API address for accessing this Page resource. + format: uri + example: https://api.github.com/repos/github/hello-world/pages + status: + type: string + description: The status of the most recent build of the Page. + example: built + enum: + - built + - building + - errored + nullable: true + cname: + description: The Pages site's custom domain + example: example.com + type: string + nullable: true + protected_domain_state: + type: string + description: The state if the domain is verified + example: pending + nullable: true + enum: + - pending + - verified + - unverified + pending_domain_unverified_at: + type: string + description: The timestamp when a pending domain becomes unverified. + nullable: true + format: date-time + custom_404: + type: boolean + description: Whether the Page has a custom 404 page. + example: false + default: false + html_url: + type: string + description: The web address the Page can be accessed from. + format: uri + example: https://example.com + build_type: + type: string + description: The process in which the Page will be built. + example: legacy + nullable: true + enum: + - legacy + - workflow + source: + "$ref": "#/components/schemas/pages-source-hash" + public: + type: boolean + description: Whether the GitHub Pages site is publicly visible. If set to + `true`, the site is accessible to anyone on the internet. If set to `false`, + the site will only be accessible to users who have at least `read` access + to the repository that published the site. + example: true + https_certificate: + "$ref": "#/components/schemas/pages-https-certificate" + https_enforced: + type: boolean + description: Whether https is enabled on the domain + example: true + required: + - url + - status + - cname + - custom_404 + - public + page-build: + title: Page Build + description: Page Build + type: object + properties: + url: + type: string + format: uri + status: + type: string + error: + type: object + properties: + message: + type: string + nullable: true + required: + - message + pusher: + "$ref": "#/components/schemas/nullable-simple-user" + commit: + type: string + duration: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - url + - status + - error + - pusher + - commit + - duration + - created_at + - updated_at + page-build-status: + title: Page Build Status + description: Page Build Status + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/github/hello-world/pages/builds/latest + status: + type: string + example: queued + required: + - url + - status + page-deployment: + title: GitHub Pages + description: The GitHub Pages deployment status. + type: object + properties: + status_url: + type: string + description: The URI to monitor GitHub Pages deployment status. + format: uri + example: https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status + page_url: + type: string + description: The URI to the deployed GitHub Pages. + format: uri + example: hello-world.github.io + preview_url: + type: string + description: The URI to the deployed GitHub Pages preview. + format: uri + example: monalisa-1231a2312sa32-23sda74.drafts.github.io + required: + - status_url + - page_url + pages-health-check: + title: Pages Health Check Status + description: Pages Health Check Status + type: object + properties: + domain: + type: object + properties: + host: + type: string + uri: + type: string + nameservers: + type: string + dns_resolves: + type: boolean + is_proxied: + type: boolean + nullable: true + is_cloudflare_ip: + type: boolean + nullable: true + is_fastly_ip: + type: boolean + nullable: true + is_old_ip_address: + type: boolean + nullable: true + is_a_record: + type: boolean + nullable: true + has_cname_record: + type: boolean + nullable: true + has_mx_records_present: + type: boolean + nullable: true + is_valid_domain: + type: boolean + is_apex_domain: + type: boolean + should_be_a_record: + type: boolean + nullable: true + is_cname_to_github_user_domain: + type: boolean + nullable: true + is_cname_to_pages_dot_github_dot_com: + type: boolean + nullable: true + is_cname_to_fastly: + type: boolean + nullable: true + is_pointed_to_github_pages_ip: + type: boolean + nullable: true + is_non_github_pages_ip_present: + type: boolean + nullable: true + is_pages_domain: + type: boolean + is_served_by_pages: + type: boolean + nullable: true + is_valid: + type: boolean + reason: + type: string + nullable: true + responds_to_https: + type: boolean + enforces_https: + type: boolean + https_error: + type: string + nullable: true + is_https_eligible: + type: boolean + nullable: true + caa_error: + type: string + nullable: true + alt_domain: + type: object + nullable: true + properties: + host: + type: string + uri: + type: string + nameservers: + type: string + dns_resolves: + type: boolean + is_proxied: + type: boolean + nullable: true + is_cloudflare_ip: + type: boolean + nullable: true + is_fastly_ip: + type: boolean + nullable: true + is_old_ip_address: + type: boolean + nullable: true + is_a_record: + type: boolean + nullable: true + has_cname_record: + type: boolean + nullable: true + has_mx_records_present: + type: boolean + nullable: true + is_valid_domain: + type: boolean + is_apex_domain: + type: boolean + should_be_a_record: + type: boolean + nullable: true + is_cname_to_github_user_domain: + type: boolean + nullable: true + is_cname_to_pages_dot_github_dot_com: + type: boolean + nullable: true + is_cname_to_fastly: + type: boolean + nullable: true + is_pointed_to_github_pages_ip: + type: boolean + nullable: true + is_non_github_pages_ip_present: + type: boolean + nullable: true + is_pages_domain: + type: boolean + is_served_by_pages: + type: boolean + nullable: true + is_valid: + type: boolean + reason: + type: string + nullable: true + responds_to_https: + type: boolean + enforces_https: + type: boolean + https_error: + type: string + nullable: true + is_https_eligible: + type: boolean + nullable: true + caa_error: + type: string + nullable: true + pull-request: + type: object + title: Pull Request + description: Pull requests let you tell others about changes you've pushed to + a repository on GitHub. Once a pull request is sent, interested parties can + review the set of changes, discuss potential modifications, and even push + follow-up commits if necessary. + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + id: + type: integer + example: 1 + node_id: + type: string + example: MDExOlB1bGxSZXF1ZXN0MQ== + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1347 + diff_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + comments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + statuses_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + number: + description: Number uniquely identifying the pull request within its repository. + example: 42 + type: integer + state: + description: State of this Pull Request. Either `open` or `closed`. + enum: + - open + - closed + example: open + type: string + locked: + type: boolean + example: true + title: + description: The title of the pull request. + example: Amazing new feature + type: string + user: + "$ref": "#/components/schemas/nullable-simple-user" + body: + type: string + example: Please pull these awesome changes + nullable: true + labels: + type: array + items: + type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + type: string + name: + type: string + description: + type: string + nullable: true + color: + type: string + default: + type: boolean + required: + - id + - node_id + - url + - name + - description + - color + - default + milestone: + "$ref": "#/components/schemas/nullable-milestone" + active_lock_reason: + type: string + example: too heated + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + closed_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + merged_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + merge_commit_sha: + type: string + example: e5bd3914e2e596debea16f433f57875b5b90bcd6 + nullable: true + assignee: + "$ref": "#/components/schemas/nullable-simple-user" + assignees: + type: array + items: + "$ref": "#/components/schemas/simple-user" + nullable: true + requested_reviewers: + type: array + items: + "$ref": "#/components/schemas/simple-user" + nullable: true + requested_teams: + type: array + items: + "$ref": "#/components/schemas/team-simple" + nullable: true + head: + type: object + properties: + label: + type: string + ref: + type: string + repo: + type: object + nullable: true + properties: + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + format: uri + deployments_url: + type: string + format: uri + description: + type: string + nullable: true + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + node_id: + type: string + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + format: uri + merges_url: + type: string + format: uri + milestones_url: + type: string + name: + type: string + notifications_url: + type: string + owner: + type: object + properties: + avatar_url: + type: string + format: uri + events_url: + type: string + followers_url: + type: string + format: uri + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + nullable: true + html_url: + type: string + format: uri + id: + type: integer + node_id: + type: string + login: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + format: uri + type: + type: string + url: + type: string + format: uri + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + format: uri + statuses_url: + type: string + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + trees_url: + type: string + url: + type: string + format: uri + clone_url: + type: string + default_branch: + type: string + forks: + type: integer + forks_count: + type: integer + git_url: + type: string + has_downloads: + type: boolean + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_discussions: + type: boolean + homepage: + type: string + format: uri + nullable: true + language: + type: string + nullable: true + master_branch: + type: string + archived: + type: boolean + disabled: + type: boolean + visibility: + description: 'The repository visibility: public, private, or internal.' + type: string + mirror_url: + type: string + format: uri + nullable: true + open_issues: + type: integer + open_issues_count: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + required: + - admin + - pull + - push + temp_clone_token: + type: string + allow_merge_commit: + type: boolean + allow_squash_merge: + type: boolean + allow_rebase_merge: + type: boolean + license: + type: object + properties: + key: + type: string + name: + type: string + url: + type: string + format: uri + nullable: true + spdx_id: + type: string + nullable: true + node_id: + type: string + required: + - key + - name + - url + - spdx_id + - node_id + nullable: true + pushed_at: + type: string + format: date-time + size: + type: integer + ssh_url: + type: string + stargazers_count: + type: integer + svn_url: + type: string + format: uri + topics: + type: array + items: + type: string + watchers: + type: integer + watchers_count: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + allow_forking: + type: boolean + is_template: + type: boolean + web_commit_signoff_required: + type: boolean + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - has_discussions + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + sha: + type: string + user: + type: object + properties: + avatar_url: + type: string + format: uri + events_url: + type: string + followers_url: + type: string + format: uri + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + nullable: true + html_url: + type: string + format: uri + id: + type: integer + node_id: + type: string + login: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + format: uri + type: + type: string + url: + type: string + format: uri + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + required: + - label + - ref + - repo + - sha + - user + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + type: object + properties: + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + format: uri + deployments_url: + type: string + format: uri + description: + type: string + nullable: true + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + is_template: + type: boolean + node_id: + type: string + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + format: uri + merges_url: + type: string + format: uri + milestones_url: + type: string + name: + type: string + notifications_url: + type: string + owner: + type: object + properties: + avatar_url: + type: string + format: uri + events_url: + type: string + followers_url: + type: string + format: uri + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + nullable: true + html_url: + type: string + format: uri + id: + type: integer + node_id: + type: string + login: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + format: uri + type: + type: string + url: + type: string + format: uri + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + format: uri + statuses_url: + type: string + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + trees_url: + type: string + url: + type: string + format: uri + clone_url: + type: string + default_branch: + type: string + forks: + type: integer + forks_count: + type: integer + git_url: + type: string + has_downloads: + type: boolean + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_discussions: + type: boolean + homepage: + type: string + format: uri + nullable: true + language: + type: string + nullable: true + master_branch: + type: string + archived: + type: boolean + disabled: + type: boolean + visibility: + description: 'The repository visibility: public, private, or internal.' + type: string + mirror_url: + type: string + format: uri + nullable: true + open_issues: + type: integer + open_issues_count: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + required: + - admin + - pull + - push + temp_clone_token: + type: string + allow_merge_commit: + type: boolean + allow_squash_merge: + type: boolean + allow_rebase_merge: + type: boolean + license: + "$ref": "#/components/schemas/nullable-license-simple" + pushed_at: + type: string + format: date-time + size: + type: integer + ssh_url: + type: string + stargazers_count: + type: integer + svn_url: + type: string + format: uri + topics: + type: array + items: + type: string + watchers: + type: integer + watchers_count: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + allow_forking: + type: boolean + web_commit_signoff_required: + type: boolean + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - has_discussions + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + sha: + type: string + user: + type: object + properties: + avatar_url: + type: string + format: uri + events_url: + type: string + followers_url: + type: string + format: uri + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + nullable: true + html_url: + type: string + format: uri + id: + type: integer + node_id: + type: string + login: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + format: uri + type: + type: string + url: + type: string + format: uri + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + required: + - label + - ref + - repo + - sha + - user + _links: + type: object + properties: + comments: + "$ref": "#/components/schemas/link" + commits: + "$ref": "#/components/schemas/link" + statuses: + "$ref": "#/components/schemas/link" + html: + "$ref": "#/components/schemas/link" + issue: + "$ref": "#/components/schemas/link" + review_comments: + "$ref": "#/components/schemas/link" + review_comment: + "$ref": "#/components/schemas/link" + self: + "$ref": "#/components/schemas/link" + required: + - comments + - commits + - statuses + - html + - issue + - review_comments + - review_comment + - self + author_association: + "$ref": "#/components/schemas/author-association" + auto_merge: + "$ref": "#/components/schemas/auto-merge" + draft: + description: Indicates whether or not the pull request is a draft. + example: false + type: boolean + merged: + type: boolean + mergeable: + type: boolean + example: true + nullable: true + rebaseable: + type: boolean + example: true + nullable: true + mergeable_state: + type: string + example: clean + merged_by: + "$ref": "#/components/schemas/nullable-simple-user" + comments: + type: integer + example: 10 + review_comments: + type: integer + example: 0 + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull request. + example: true + type: boolean + commits: + type: integer + example: 3 + additions: + type: integer + example: 100 + deletions: + type: integer + example: 3 + changed_files: + type: integer + example: 5 + required: + - _links + - assignee + - labels + - base + - body + - closed_at + - comments_url + - commits_url + - created_at + - diff_url + - head + - html_url + - id + - node_id + - issue_url + - merge_commit_sha + - merged_at + - milestone + - number + - patch_url + - review_comment_url + - review_comments_url + - statuses_url + - state + - locked + - title + - updated_at + - url + - user + - author_association + - auto_merge + - additions + - changed_files + - comments + - commits + - deletions + - mergeable + - mergeable_state + - merged + - maintainer_can_modify + - merged_by + - review_comments + pull-request-merge-result: + title: Pull Request Merge Result + description: Pull Request Merge Result + type: object + properties: + sha: + type: string + merged: + type: boolean + message: + type: string + required: + - merged + - message + - sha + pull-request-review-request: + title: Pull Request Review Request + description: Pull Request Review Request + type: object + properties: + users: + type: array + items: + "$ref": "#/components/schemas/simple-user" + teams: + type: array + items: + "$ref": "#/components/schemas/team" + required: + - users + - teams + pull-request-review: + title: Pull Request Review + description: Pull Request Reviews are reviews on pull requests. + type: object + properties: + id: + description: Unique identifier of the review + example: 42 + type: integer + node_id: + type: string + example: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= + user: + "$ref": "#/components/schemas/nullable-simple-user" + body: + description: The text of the review. + example: This looks great. + type: string + state: + type: string + example: CHANGES_REQUESTED + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/12 + _links: + type: object + properties: + html: + type: object + properties: + href: + type: string + required: + - href + pull_request: + type: object + properties: + href: + type: string + required: + - href + required: + - html + - pull_request + submitted_at: + type: string + format: date-time + commit_id: + description: A commit SHA for the review. + example: 54bb654c9e6025347f57900a4a5c2313a96b8035 + type: string + body_html: + type: string + body_text: + type: string + author_association: + "$ref": "#/components/schemas/author-association" + required: + - id + - node_id + - user + - body + - state + - commit_id + - html_url + - pull_request_url + - _links + - author_association + review-comment: + title: Legacy Review Comment + description: Legacy Review Comment + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + pull_request_review_id: + type: integer + example: 42 + nullable: true + id: + type: integer + example: 10 + node_id: + type: string + example: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw + diff_hunk: + type: string + example: "@@ -16,33 +16,40 @@ public class Connection : IConnection..." + path: + type: string + example: file1.txt + position: + type: integer + example: 1 + nullable: true + original_position: + type: integer + example: 4 + commit_id: + type: string + example: 6dcb09b5b57875f334f61aebed695e2e4193db5e + original_commit_id: + type: string + example: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 + in_reply_to_id: + type: integer + example: 8 + user: + "$ref": "#/components/schemas/nullable-simple-user" + body: + type: string + example: Great stuff + created_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + pull_request_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1 + author_association: + "$ref": "#/components/schemas/author-association" + _links: + type: object + properties: + self: + "$ref": "#/components/schemas/link" + html: + "$ref": "#/components/schemas/link" + pull_request: + "$ref": "#/components/schemas/link" + required: + - self + - html + - pull_request + body_text: + type: string + body_html: + type: string + reactions: + "$ref": "#/components/schemas/reaction-rollup" + side: + description: The side of the first line of the range for a multi-line comment. + enum: + - LEFT + - RIGHT + default: RIGHT + type: string + start_side: + type: string + description: The side of the first line of the range for a multi-line comment. + enum: + - LEFT + - RIGHT + default: RIGHT + nullable: true + line: + description: The line of the blob to which the comment applies. The last + line of the range for a multi-line comment + example: 2 + type: integer + original_line: + description: The original line of the blob to which the comment applies. + The last line of the range for a multi-line comment + example: 2 + type: integer + start_line: + description: The first line of the range for a multi-line comment. + example: 2 + type: integer + nullable: true + original_start_line: + description: The original first line of the range for a multi-line comment. + example: 2 + type: integer + nullable: true + required: + - id + - node_id + - url + - body + - diff_hunk + - path + - position + - original_position + - commit_id + - original_commit_id + - user + - pull_request_review_id + - html_url + - pull_request_url + - _links + - author_association + - created_at + - updated_at + release-asset: + title: Release Asset + description: Data related to a release. + type: object + properties: + url: + type: string + format: uri + browser_download_url: + type: string + format: uri + id: + type: integer + node_id: + type: string + name: + description: The file name of the asset. + type: string + example: Team Environment + label: + type: string + nullable: true + state: + description: State of the release asset. + type: string + enum: + - uploaded + - open + content_type: + type: string + size: + type: integer + download_count: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + uploader: + "$ref": "#/components/schemas/nullable-simple-user" + required: + - id + - name + - content_type + - size + - state + - url + - node_id + - download_count + - label + - uploader + - browser_download_url + - created_at + - updated_at + release: + title: Release + description: A release. + type: object + properties: + url: + type: string + format: uri + html_url: + type: string + format: uri + assets_url: + type: string + format: uri + upload_url: + type: string + tarball_url: + type: string + format: uri + nullable: true + zipball_url: + type: string + format: uri + nullable: true + id: + type: integer + node_id: + type: string + tag_name: + description: The name of the tag. + example: v1.0.0 + type: string + target_commitish: + description: Specifies the commitish value that determines where the Git + tag is created from. + example: master + type: string + name: + type: string + nullable: true + body: + type: string + nullable: true + draft: + description: true to create a draft (unpublished) release, false to create + a published one. + example: false + type: boolean + prerelease: + description: Whether to identify the release as a prerelease or a full release. + example: false + type: boolean + created_at: + type: string + format: date-time + published_at: + type: string + format: date-time + nullable: true + author: + "$ref": "#/components/schemas/simple-user" + assets: + type: array + items: + "$ref": "#/components/schemas/release-asset" + body_html: + type: string + body_text: + type: string + mentions_count: + type: integer + discussion_url: + description: The URL of the release discussion. + type: string + format: uri + reactions: + "$ref": "#/components/schemas/reaction-rollup" + required: + - assets_url + - upload_url + - tarball_url + - zipball_url + - created_at + - published_at + - draft + - id + - node_id + - author + - html_url + - name + - prerelease + - tag_name + - target_commitish + - assets + - url + release-notes-content: + title: Generated Release Notes Content + description: Generated name and body describing a release + type: object + properties: + name: + description: The generated name of the release + type: string + example: Release v1.0.0 is now available! + body: + description: The generated body describing the contents of the release supporting + markdown formatting + type: string + required: + - name + - body + secret-scanning-alert: + type: object + properties: + number: + "$ref": "#/components/schemas/alert-number" + created_at: + "$ref": "#/components/schemas/alert-created-at" + updated_at: + "$ref": "#/components/schemas/alert-updated-at" + url: + "$ref": "#/components/schemas/alert-url" + html_url: + "$ref": "#/components/schemas/alert-html-url" + locations_url: + type: string + format: uri + description: The REST API URL of the code locations for this alert. + state: + "$ref": "#/components/schemas/secret-scanning-alert-state" + resolution: + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + resolved_at: + type: string + format: date-time + description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + resolved_by: + "$ref": "#/components/schemas/nullable-simple-user" + resolution_comment: + type: string + description: An optional comment to resolve an alert. + nullable: true + secret_type: + type: string + description: The type of secret that secret scanning detected. + secret_type_display_name: + type: string + description: |- + User-friendly name for the detected secret, matching the `secret_type`. + For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." + secret: + type: string + description: The secret that was detected. + push_protection_bypassed: + type: boolean + description: Whether push protection was bypassed for the detected secret. + nullable: true + push_protection_bypassed_by: + "$ref": "#/components/schemas/nullable-simple-user" + push_protection_bypassed_at: + type: string + format: date-time + description: 'The time that push protection was bypassed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + secret-scanning-alert-resolution-comment: + description: An optional comment when closing an alert. Cannot be updated or + deleted. Must be `null` when changing `state` to `open`. + type: string + nullable: true + secret-scanning-location-commit: + description: Represents a 'commit' secret scanning location type. This location + type shows that a secret was detected inside a commit to a repository. + type: object + properties: + path: + type: string + description: The file path in the repository + example: "/example/secrets.txt" + start_line: + type: number + description: Line number at which the secret starts in the file + end_line: + type: number + description: Line number at which the secret ends in the file + start_column: + type: number + description: The column at which the secret starts within the start line + when the file is interpreted as 8BIT ASCII + end_column: + type: number + description: The column at which the secret ends within the end line when + the file is interpreted as 8BIT ASCII + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: + type: string + description: The API URL to get the associated blob resource + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_url: + type: string + description: The API URL to get the associated commit resource + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - blob_url + - commit_sha + - commit_url + secret-scanning-location: + type: object + properties: + type: + type: string + enum: + - commit + description: The location type. Because secrets may be found in different + types of resources (ie. code, comments, issues), this field identifies + the type of resource where the secret was found. + example: commit + details: + oneOf: + - "$ref": "#/components/schemas/secret-scanning-location-commit" + required: + - type + - details + stargazer: + title: Stargazer + description: Stargazer + type: object + properties: + starred_at: + type: string + format: date-time + user: + "$ref": "#/components/schemas/nullable-simple-user" + required: + - starred_at + - user + code-frequency-stat: + title: Code Frequency Stat + description: Code Frequency Stat + type: array + items: + type: integer + commit-activity: + title: Commit Activity + description: Commit Activity + type: object + properties: + days: + type: array + example: + - 0 + - 3 + - 26 + - 20 + - 39 + - 1 + - 0 + items: + type: integer + total: + type: integer + example: 89 + week: + type: integer + example: 1336280400 + required: + - days + - total + - week + contributor-activity: + title: Contributor Activity + description: Contributor Activity + type: object + properties: + author: + "$ref": "#/components/schemas/nullable-simple-user" + total: + type: integer + example: 135 + weeks: + type: array + example: + - w: '1367712000' + a: 6898 + d: 77 + c: 10 + items: + type: object + properties: + w: + type: integer + a: + type: integer + d: + type: integer + c: + type: integer + required: + - author + - total + - weeks + participation-stats: + title: Participation Stats + type: object + properties: + all: + type: array + items: + type: integer + owner: + type: array + items: + type: integer + required: + - all + - owner + repository-subscription: + title: Repository Invitation + description: Repository invitations let you manage who you collaborate with. + type: object + properties: + subscribed: + description: Determines if notifications should be received from this repository. + type: boolean + example: true + ignored: + description: Determines if all notifications should be blocked from this + repository. + type: boolean + reason: + type: string + nullable: true + created_at: + type: string + format: date-time + example: '2012-10-06T21:34:12Z' + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example/subscription + repository_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example + required: + - created_at + - ignored + - reason + - subscribed + - url + - repository_url + tag: + title: Tag + description: Tag + type: object + properties: + name: + type: string + example: v0.1 + commit: + type: object + properties: + sha: + type: string + url: + type: string + format: uri + required: + - sha + - url + zipball_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/zipball/v0.1 + tarball_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/tarball/v0.1 + node_id: + type: string + required: + - name + - node_id + - commit + - zipball_url + - tarball_url + tag-protection: + title: Tag protection + description: Tag protection + type: object + properties: + id: + type: integer + example: 2 + created_at: + type: string + example: '2011-01-26T19:01:12Z' + updated_at: + type: string + example: '2011-01-26T19:01:12Z' + enabled: + type: boolean + example: true + pattern: + type: string + example: v1.* + required: + - pattern + topic: + title: Topic + description: A topic aggregates entities that are related to a subject. + type: object + properties: + names: + type: array + items: + type: string + required: + - names + traffic: + title: Traffic + type: object + properties: + timestamp: + type: string + format: date-time + uniques: + type: integer + count: + type: integer + required: + - timestamp + - uniques + - count + clone-traffic: + title: Clone Traffic + description: Clone Traffic + type: object + properties: + count: + type: integer + example: 173 + uniques: + type: integer + example: 128 + clones: + type: array + items: + "$ref": "#/components/schemas/traffic" + required: + - uniques + - count + - clones + content-traffic: + title: Content Traffic + description: Content Traffic + type: object + properties: + path: + type: string + example: "/github/hubot" + title: + type: string + example: 'github/hubot: A customizable life embetterment robot.' + count: + type: integer + example: 3542 + uniques: + type: integer + example: 2225 + required: + - path + - title + - uniques + - count + referrer-traffic: + title: Referrer Traffic + description: Referrer Traffic + type: object + properties: + referrer: + type: string + example: Google + count: + type: integer + example: 4 + uniques: + type: integer + example: 3 + required: + - referrer + - uniques + - count + view-traffic: + title: View Traffic + description: View Traffic + type: object + properties: + count: + type: integer + example: 14850 + uniques: + type: integer + example: 3782 + views: + type: array + items: + "$ref": "#/components/schemas/traffic" + required: + - uniques + - count + - views + search-result-text-matches: + title: Search Result Text Matches + type: array + items: + type: object + properties: + object_url: + type: string + object_type: + nullable: true + type: string + property: + type: string + fragment: + type: string + matches: + type: array + items: + type: object + properties: + text: + type: string + indices: + type: array + items: + type: integer + code-search-result-item: + title: Code Search Result Item + description: Code Search Result Item + type: object + properties: + name: + type: string + path: + type: string + sha: + type: string + url: + type: string + format: uri + git_url: + type: string + format: uri + html_url: + type: string + format: uri + repository: + "$ref": "#/components/schemas/minimal-repository" + score: + type: number + file_size: + type: integer + language: + type: string + nullable: true + last_modified_at: + type: string + format: date-time + line_numbers: + type: array + items: + type: string + example: + - 73..77 + - 77..78 + text_matches: + "$ref": "#/components/schemas/search-result-text-matches" + required: + - score + - name + - path + - sha + - git_url + - html_url + - url + - repository + commit-search-result-item: + title: Commit Search Result Item + description: Commit Search Result Item + type: object + properties: + url: + type: string + format: uri + sha: + type: string + html_url: + type: string + format: uri + comments_url: + type: string + format: uri + commit: + type: object + properties: + author: + type: object + properties: + name: + type: string + email: + type: string + date: + type: string + format: date-time + required: + - name + - email + - date + committer: + "$ref": "#/components/schemas/nullable-git-user" + comment_count: + type: integer + message: + type: string + tree: + type: object + properties: + sha: + type: string + url: + type: string + format: uri + required: + - sha + - url + url: + type: string + format: uri + verification: + "$ref": "#/components/schemas/verification" + required: + - author + - committer + - comment_count + - message + - tree + - url + author: + "$ref": "#/components/schemas/nullable-simple-user" + committer: + "$ref": "#/components/schemas/nullable-git-user" + parents: + type: array + items: + type: object + properties: + url: + type: string + html_url: + type: string + sha: + type: string + repository: + "$ref": "#/components/schemas/minimal-repository" + score: + type: number + node_id: + type: string + text_matches: + "$ref": "#/components/schemas/search-result-text-matches" + required: + - sha + - node_id + - url + - html_url + - author + - committer + - parents + - comments_url + - commit + - repository + - score + issue-search-result-item: + title: Issue Search Result Item + description: Issue Search Result Item + type: object + properties: + url: + type: string + format: uri + repository_url: + type: string + format: uri + labels_url: + type: string + comments_url: + type: string + format: uri + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + node_id: + type: string + number: + type: integer + title: + type: string + locked: + type: boolean + active_lock_reason: + type: string + nullable: true + assignees: + type: array + items: + "$ref": "#/components/schemas/simple-user" + nullable: true + user: + "$ref": "#/components/schemas/nullable-simple-user" + labels: + type: array + items: + type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + type: string + name: + type: string + color: + type: string + default: + type: boolean + description: + type: string + nullable: true + state: + type: string + state_reason: + type: string + nullable: true + assignee: + "$ref": "#/components/schemas/nullable-simple-user" + milestone: + "$ref": "#/components/schemas/nullable-milestone" + comments: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + closed_at: + type: string + format: date-time + nullable: true + text_matches: + "$ref": "#/components/schemas/search-result-text-matches" + pull_request: + type: object + properties: + merged_at: + type: string + format: date-time + nullable: true + diff_url: + type: string + format: uri + nullable: true + html_url: + type: string + format: uri + nullable: true + patch_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + nullable: true + required: + - diff_url + - html_url + - patch_url + - url + body: + type: string + score: + type: number + author_association: + "$ref": "#/components/schemas/author-association" + draft: + type: boolean + repository: + "$ref": "#/components/schemas/repository" + body_html: + type: string + body_text: + type: string + timeline_url: + type: string + format: uri + performed_via_github_app: + "$ref": "#/components/schemas/nullable-integration" + reactions: + "$ref": "#/components/schemas/reaction-rollup" + required: + - assignee + - closed_at + - comments + - comments_url + - events_url + - html_url + - id + - node_id + - labels + - labels_url + - milestone + - number + - repository_url + - state + - locked + - title + - url + - user + - author_association + - created_at + - updated_at + - score + label-search-result-item: + title: Label Search Result Item + description: Label Search Result Item + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + format: uri + name: + type: string + color: + type: string + default: + type: boolean + description: + type: string + nullable: true + score: + type: number + text_matches: + "$ref": "#/components/schemas/search-result-text-matches" + required: + - id + - node_id + - url + - name + - color + - default + - description + - score + repo-search-result-item: + title: Repo Search Result Item + description: Repo Search Result Item + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + full_name: + type: string + owner: + "$ref": "#/components/schemas/nullable-simple-user" + private: + type: boolean + html_url: + type: string + format: uri + description: + type: string + nullable: true + fork: + type: boolean + url: + type: string + format: uri + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + pushed_at: + type: string + format: date-time + homepage: + type: string + format: uri + nullable: true + size: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + language: + type: string + nullable: true + forks_count: + type: integer + open_issues_count: + type: integer + master_branch: + type: string + default_branch: + type: string + score: + type: number + forks_url: + type: string + format: uri + keys_url: + type: string + collaborators_url: + type: string + teams_url: + type: string + format: uri + hooks_url: + type: string + format: uri + issue_events_url: + type: string + events_url: + type: string + format: uri + assignees_url: + type: string + branches_url: + type: string + tags_url: + type: string + format: uri + blobs_url: + type: string + git_tags_url: + type: string + git_refs_url: + type: string + trees_url: + type: string + statuses_url: + type: string + languages_url: + type: string + format: uri + stargazers_url: + type: string + format: uri + contributors_url: + type: string + format: uri + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + commits_url: + type: string + git_commits_url: + type: string + comments_url: + type: string + issue_comment_url: + type: string + contents_url: + type: string + compare_url: + type: string + merges_url: + type: string + format: uri + archive_url: + type: string + downloads_url: + type: string + format: uri + issues_url: + type: string + pulls_url: + type: string + milestones_url: + type: string + notifications_url: + type: string + labels_url: + type: string + releases_url: + type: string + deployments_url: + type: string + format: uri + git_url: + type: string + ssh_url: + type: string + clone_url: + type: string + svn_url: + type: string + format: uri + forks: + type: integer + open_issues: + type: integer + watchers: + type: integer + topics: + type: array + items: + type: string + mirror_url: + type: string + format: uri + nullable: true + has_issues: + type: boolean + has_projects: + type: boolean + has_pages: + type: boolean + has_wiki: + type: boolean + has_downloads: + type: boolean + has_discussions: + type: boolean + archived: + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + type: string + license: + "$ref": "#/components/schemas/nullable-license-simple" + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + required: + - admin + - pull + - push + text_matches: + "$ref": "#/components/schemas/search-result-text-matches" + temp_clone_token: + type: string + allow_merge_commit: + type: boolean + allow_squash_merge: + type: boolean + allow_rebase_merge: + type: boolean + allow_auto_merge: + type: boolean + delete_branch_on_merge: + type: boolean + allow_forking: + type: boolean + is_template: + type: boolean + web_commit_signoff_required: + type: boolean + example: false + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + - score + topic-search-result-item: + title: Topic Search Result Item + description: Topic Search Result Item + type: object + properties: + name: + type: string + display_name: + type: string + nullable: true + short_description: + type: string + nullable: true + description: + type: string + nullable: true + created_by: + type: string + nullable: true + released: + type: string + nullable: true + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + featured: + type: boolean + curated: + type: boolean + score: + type: number + repository_count: + type: integer + nullable: true + logo_url: + type: string + format: uri + nullable: true + text_matches: + "$ref": "#/components/schemas/search-result-text-matches" + related: + type: array + nullable: true + items: + type: object + properties: + topic_relation: + type: object + properties: + id: + type: integer + name: + type: string + topic_id: + type: integer + relation_type: + type: string + aliases: + type: array + nullable: true + items: + type: object + properties: + topic_relation: + type: object + properties: + id: + type: integer + name: + type: string + topic_id: + type: integer + relation_type: + type: string + required: + - name + - display_name + - short_description + - description + - created_by + - released + - created_at + - updated_at + - featured + - curated + - score + user-search-result-item: + title: User Search Result Item + description: User Search Result Item + type: object + properties: + login: + type: string + id: + type: integer + node_id: + type: string + avatar_url: + type: string + format: uri + gravatar_id: + type: string + nullable: true + url: + type: string + format: uri + html_url: + type: string + format: uri + followers_url: + type: string + format: uri + subscriptions_url: + type: string + format: uri + organizations_url: + type: string + format: uri + repos_url: + type: string + format: uri + received_events_url: + type: string + format: uri + type: + type: string + score: + type: number + following_url: + type: string + gists_url: + type: string + starred_url: + type: string + events_url: + type: string + public_repos: + type: integer + public_gists: + type: integer + followers: + type: integer + following: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + name: + type: string + nullable: true + bio: + type: string + nullable: true + email: + type: string + format: email + nullable: true + location: + type: string + nullable: true + site_admin: + type: boolean + hireable: + type: boolean + nullable: true + text_matches: + "$ref": "#/components/schemas/search-result-text-matches" + blog: + type: string + nullable: true + company: + type: string + nullable: true + suspended_at: + type: string + format: date-time + nullable: true + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - score + private-user: + title: Private User + description: Private User + type: object + properties: + login: + type: string + example: octocat + id: + type: integer + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + name: + type: string + example: monalisa octocat + nullable: true + company: + type: string + example: GitHub + nullable: true + blog: + type: string + example: https://github.com/blog + nullable: true + location: + type: string + example: San Francisco + nullable: true + email: + type: string + format: email + example: octocat@github.com + nullable: true + hireable: + type: boolean + nullable: true + bio: + type: string + example: There once was... + nullable: true + twitter_username: + type: string + example: monalisa + nullable: true + public_repos: + type: integer + example: 2 + public_gists: + type: integer + example: 1 + followers: + type: integer + example: 20 + following: + type: integer + example: 0 + created_at: + type: string + format: date-time + example: '2008-01-14T04:33:35Z' + updated_at: + type: string + format: date-time + example: '2008-01-14T04:33:35Z' + private_gists: + type: integer + example: 81 + total_private_repos: + type: integer + example: 100 + owned_private_repos: + type: integer + example: 100 + disk_usage: + type: integer + example: 10000 + collaborators: + type: integer + example: 8 + two_factor_authentication: + type: boolean + example: true + plan: + type: object + properties: + collaborators: + type: integer + name: + type: string + space: + type: integer + private_repos: + type: integer + required: + - collaborators + - name + - space + - private_repos + suspended_at: + type: string + format: date-time + nullable: true + business_plus: + type: boolean + ldap_dn: + type: string + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - bio + - blog + - company + - email + - followers + - following + - hireable + - location + - name + - public_gists + - public_repos + - created_at + - updated_at + - collaborators + - disk_usage + - owned_private_repos + - private_gists + - total_private_repos + - two_factor_authentication + codespaces-secret: + title: Codespaces Secret + description: Secrets for a GitHub Codespace. + type: object + properties: + name: + description: The name of the secret + example: SECRET_NAME + type: string + created_at: + description: The date and time at which the secret was created, in ISO 8601 + format':' YYYY-MM-DDTHH:MM:SSZ. + type: string + format: date-time + updated_at: + description: The date and time at which the secret was last updated, in + ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + type: string + format: date-time + visibility: + description: The type of repositories in the organization that the secret + is visible to + enum: + - all + - private + - selected + type: string + selected_repositories_url: + description: The API URL at which the list of repositories this secret is + visible to can be retrieved + type: string + format: uri + example: https://api.github.com/user/secrets/SECRET_NAME/repositories + required: + - name + - created_at + - updated_at + - visibility + - selected_repositories_url + codespaces-user-public-key: + title: CodespacesUserPublicKey + description: The public key used for setting user Codespaces' Secrets. + type: object + properties: + key_id: + description: The identifier for the key. + type: string + example: '1234567' + key: + description: The Base64 encoded public key. + type: string + example: hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= + required: + - key_id + - key + codespace-export-details: + type: object + title: Fetches information about an export of a codespace. + description: An export of a codespace. Also, latest export details for a codespace + can be fetched with id = latest + properties: + state: + type: string + description: State of the latest export + nullable: true + example: succeeded | failed | in_progress + completed_at: + description: Completion time of the last export operation + type: string + format: date-time + nullable: true + example: '2021-01-01T19:01:12Z' + branch: + type: string + description: Name of the exported branch + nullable: true + example: codespace-monalisa-octocat-hello-world-g4wpq6h95q + sha: + type: string + description: Git commit SHA of the exported branch + nullable: true + example: fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 + id: + type: string + description: Id for the export details + example: latest + export_url: + type: string + description: Url for fetching export details + example: https://api.github.com/user/codespaces/:name/exports/latest + html_url: + type: string + nullable: true + description: Web url for the exported branch + example: https://github.com/octocat/hello-world/tree/:branch + email: + title: Email + description: Email + type: object + properties: + email: + type: string + format: email + example: octocat@github.com + primary: + type: boolean + example: true + verified: + type: boolean + example: true + visibility: + type: string + example: public + nullable: true + required: + - email + - primary + - verified + - visibility + gpg-key: + title: GPG Key + description: A unique encryption key + type: object + properties: + id: + type: integer + example: 3 + name: + type: string + example: Octocat's GPG Key + nullable: true + primary_key_id: + type: integer + nullable: true + key_id: + type: string + example: 3262EFF25BA0D270 + public_key: + type: string + example: xsBNBFayYZ... + emails: + type: array + example: + - email: octocat@users.noreply.github.com + verified: true + items: + type: object + properties: + email: + type: string + verified: + type: boolean + subkeys: + type: array + example: + - id: 4 + primary_key_id: 3 + key_id: 4A595D4C72EE49C7 + public_key: zsBNBFayYZ... + emails: [] + subkeys: [] + can_sign: false + can_encrypt_comms: true + can_encrypt_storage: true + can_certify: false + created_at: '2016-03-24T11:31:04-06:00' + expires_at: + revoked: false + items: + type: object + properties: + id: + type: integer + primary_key_id: + type: integer + key_id: + type: string + public_key: + type: string + emails: + type: array + items: {} + subkeys: + type: array + items: {} + can_sign: + type: boolean + can_encrypt_comms: + type: boolean + can_encrypt_storage: + type: boolean + can_certify: + type: boolean + created_at: + type: string + expires_at: + type: string + nullable: true + raw_key: + type: string + nullable: true + revoked: + type: boolean + can_sign: + type: boolean + example: true + can_encrypt_comms: + type: boolean + can_encrypt_storage: + type: boolean + can_certify: + type: boolean + example: true + created_at: + type: string + format: date-time + example: '2016-03-24T11:31:04-06:00' + expires_at: + type: string + format: date-time + nullable: true + revoked: + type: boolean + example: true + raw_key: + type: string + nullable: true + required: + - id + - primary_key_id + - key_id + - raw_key + - public_key + - created_at + - expires_at + - can_sign + - can_encrypt_comms + - can_encrypt_storage + - can_certify + - emails + - subkeys + - revoked + key: + title: Key + description: Key + type: object + properties: + key: + type: string + id: + type: integer + url: + type: string + title: + type: string + created_at: + type: string + format: date-time + verified: + type: boolean + read_only: + type: boolean + required: + - key + - id + - url + - title + - created_at + - verified + - read_only + marketplace-account: + title: Marketplace Account + type: object + properties: + url: + type: string + format: uri + id: + type: integer + type: + type: string + node_id: + type: string + login: + type: string + email: + type: string + nullable: true + format: email + organization_billing_email: + type: string + nullable: true + format: email + required: + - url + - id + - type + - login + user-marketplace-purchase: + title: User Marketplace Purchase + description: User Marketplace Purchase + type: object + properties: + billing_cycle: + type: string + example: monthly + next_billing_date: + type: string + format: date-time + example: '2017-11-11T00:00:00Z' + nullable: true + unit_count: + type: integer + nullable: true + on_free_trial: + type: boolean + example: true + free_trial_ends_on: + type: string + format: date-time + example: '2017-11-11T00:00:00Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2017-11-02T01:12:12Z' + nullable: true + account: + "$ref": "#/components/schemas/marketplace-account" + plan: + "$ref": "#/components/schemas/marketplace-listing-plan" + required: + - billing_cycle + - next_billing_date + - unit_count + - updated_at + - on_free_trial + - free_trial_ends_on + - account + - plan + ssh-signing-key: + title: SSH Signing Key + description: A public SSH key used to sign Git commits + type: object + properties: + key: + type: string + id: + type: integer + title: + type: string + created_at: + type: string + format: date-time + required: + - key + - id + - title + - created_at + starred-repository: + title: Starred Repository + description: Starred Repository + type: object + properties: + starred_at: + type: string + format: date-time + repo: + "$ref": "#/components/schemas/repository" + required: + - starred_at + - repo + hovercard: + title: Hovercard + description: Hovercard + type: object + properties: + contexts: + type: array + items: + type: object + properties: + message: + type: string + octicon: + type: string + required: + - message + - octicon + required: + - contexts + key-simple: + title: Key Simple + description: Key Simple + type: object + properties: + id: + type: integer + key: + type: string + required: + - key + - id + simple-installation: + title: Simple Installation + description: The GitHub App installation. This property is included when the + event is configured for and sent to a GitHub App. + type: object + properties: + id: + description: The ID of the installation. + type: integer + example: 1 + node_id: + description: The global node ID of the installation. + type: string + example: MDQ6VXNlcjU4MzIzMQ== + required: + - id + - node_id + simple-check-suite: + description: A suite of checks performed on the code of a given code change + type: object + properties: + after: + example: d6fde92930d4715a2b49857d24b940956b26d2d3 + type: string + nullable: true + app: + "$ref": "#/components/schemas/integration" + before: + example: 146e867f55c26428e5f9fade55a9bbf5e95a7912 + type: string + nullable: true + conclusion: + example: neutral + type: string + nullable: true + enum: + - success + - failure + - neutral + - cancelled + - skipped + - timed_out + - action_required + - stale + - startup_failure + created_at: + type: string + format: date-time + head_branch: + example: master + type: string + nullable: true + head_sha: + description: The SHA of the head commit that is being checked. + example: '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' + type: string + id: + example: 5 + type: integer + node_id: + example: MDEwOkNoZWNrU3VpdGU1 + type: string + pull_requests: + type: array + items: + "$ref": "#/components/schemas/pull-request-minimal" + repository: + "$ref": "#/components/schemas/minimal-repository" + status: + example: completed + type: string + enum: + - queued + - in_progress + - completed + - pending + - waiting + updated_at: + type: string + format: date-time + url: + example: https://api.github.com/repos/github/hello-world/check-suites/5 + type: string + check-run-with-simple-check-suite: + title: CheckRun + description: A check performed on the code of a given code change + type: object + properties: + app: + "$ref": "#/components/schemas/nullable-integration" + check_suite: + "$ref": "#/components/schemas/simple-check-suite" + completed_at: + example: '2018-05-04T01:14:52Z' + type: string + nullable: true + format: date-time + conclusion: + example: neutral + type: string + nullable: true + enum: + - waiting + - pending + - startup_failure + - stale + - success + - failure + - neutral + - cancelled + - skipped + - timed_out + - action_required + deployment: + "$ref": "#/components/schemas/deployment-simple" + details_url: + example: https://example.com + type: string + external_id: + example: '42' + type: string + head_sha: + description: The SHA of the commit that is being checked. + example: '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' + type: string + html_url: + example: https://github.com/github/hello-world/runs/4 + type: string + id: + description: The id of the check. + example: 21 + type: integer + name: + description: The name of the check. + example: test-coverage + type: string + node_id: + example: MDg6Q2hlY2tSdW40 + type: string + output: + type: object + properties: + annotations_count: + type: integer + annotations_url: + type: string + format: uri + summary: + type: string + nullable: true + text: + type: string + nullable: true + title: + type: string + nullable: true + required: + - title + - summary + - text + - annotations_count + - annotations_url + pull_requests: + type: array + items: + "$ref": "#/components/schemas/pull-request-minimal" + started_at: + example: '2018-05-04T01:14:52Z' + type: string + format: date-time + status: + description: The phase of the lifecycle that the check is currently in. + example: queued + type: string + enum: + - queued + - in_progress + - completed + - pending + url: + example: https://api.github.com/repos/github/hello-world/check-runs/4 + type: string + required: + - id + - node_id + - head_sha + - name + - url + - html_url + - details_url + - status + - conclusion + - started_at + - completed_at + - external_id + - check_suite + - output + - app + - pull_requests + projects-v2-item-content-type: + title: Projects v2 Item Content Type + description: The type of content tracked in a project item + type: string + enum: + - Issue + - PullRequest + - DraftIssue + projects-v2-item: + title: Projects v2 Item + description: An item belonging to a project + type: object + properties: + id: + type: number + node_id: + type: string + project_node_id: + type: string + content_node_id: + type: string + content_type: + "$ref": "#/components/schemas/projects-v2-item-content-type" + creator: + "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + updated_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + archived_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + nullable: true + required: + - id + - content_node_id + - content_type + - created_at + - updated_at + - archived_at + webhook-branch-protection-rule-created: + title: branch protection rule created event + type: object + properties: + action: + type: string + enum: + - created + enterprise: + "$ref": "#/components/schemas/enterprise" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple" + repository: + "$ref": "#/components/schemas/repository" + rule: + title: branch protection rule + description: The branch protection rule. Includes a `name` and all the [branch + protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) + applied to branches that match the name. Binary settings are boolean. + Multi-level configurations are one of `off`, `non_admins`, or `everyone`. + Actor and build lists are arrays of strings. + type: object + properties: + admin_enforced: + type: boolean + allow_deletions_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + allow_force_pushes_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + authorized_actor_names: + type: array + items: + type: string + authorized_actors_only: + type: boolean + authorized_dismissal_actors_only: + type: boolean + create_protected: + type: boolean + created_at: + type: string + format: date-time + dismiss_stale_reviews_on_push: + type: boolean + id: + type: integer + ignore_approvals_from_contributors: + type: boolean + linear_history_requirement_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + merge_queue_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + name: + type: string + pull_request_reviews_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + repository_id: + type: integer + require_code_owner_review: + type: boolean + required_approving_review_count: + type: integer + required_conversation_resolution_level: + type: string + enum: + - 'off' + - non_admins + - everyone + required_deployments_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + required_status_checks: + type: array + items: + type: string + required_status_checks_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + signature_requirement_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + strict_required_status_checks_policy: + type: boolean + updated_at: + type: string + format: date-time + required: + - id + - repository_id + - name + - created_at + - updated_at + - pull_request_reviews_enforcement_level + - required_approving_review_count + - dismiss_stale_reviews_on_push + - require_code_owner_review + - authorized_dismissal_actors_only + - ignore_approvals_from_contributors + - required_status_checks + - required_status_checks_enforcement_level + - strict_required_status_checks_policy + - signature_requirement_enforcement_level + - linear_history_requirement_enforcement_level + - admin_enforced + - allow_force_pushes_enforcement_level + - allow_deletions_enforcement_level + - merge_queue_enforcement_level + - required_deployments_enforcement_level + - required_conversation_resolution_level + - authorized_actors_only + - authorized_actor_names + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - rule + - repository + - sender + webhook-branch-protection-rule-deleted: + title: branch protection rule deleted event + type: object + properties: + action: + type: string + enum: + - deleted + enterprise: + "$ref": "#/components/schemas/enterprise" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple" + repository: + "$ref": "#/components/schemas/repository" + rule: + title: branch protection rule + description: The branch protection rule. Includes a `name` and all the [branch + protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) + applied to branches that match the name. Binary settings are boolean. + Multi-level configurations are one of `off`, `non_admins`, or `everyone`. + Actor and build lists are arrays of strings. + type: object + properties: + admin_enforced: + type: boolean + allow_deletions_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + allow_force_pushes_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + authorized_actor_names: + type: array + items: + type: string + authorized_actors_only: + type: boolean + authorized_dismissal_actors_only: + type: boolean + create_protected: + type: boolean + created_at: + type: string + format: date-time + dismiss_stale_reviews_on_push: + type: boolean + id: + type: integer + ignore_approvals_from_contributors: + type: boolean + linear_history_requirement_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + merge_queue_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + name: + type: string + pull_request_reviews_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + repository_id: + type: integer + require_code_owner_review: + type: boolean + required_approving_review_count: + type: integer + required_conversation_resolution_level: + type: string + enum: + - 'off' + - non_admins + - everyone + required_deployments_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + required_status_checks: + type: array + items: + type: string + required_status_checks_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + signature_requirement_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + strict_required_status_checks_policy: + type: boolean + updated_at: + type: string + format: date-time + required: + - id + - repository_id + - name + - created_at + - updated_at + - pull_request_reviews_enforcement_level + - required_approving_review_count + - dismiss_stale_reviews_on_push + - require_code_owner_review + - authorized_dismissal_actors_only + - ignore_approvals_from_contributors + - required_status_checks + - required_status_checks_enforcement_level + - strict_required_status_checks_policy + - signature_requirement_enforcement_level + - linear_history_requirement_enforcement_level + - admin_enforced + - allow_force_pushes_enforcement_level + - allow_deletions_enforcement_level + - merge_queue_enforcement_level + - required_deployments_enforcement_level + - required_conversation_resolution_level + - authorized_actors_only + - authorized_actor_names + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - rule + - repository + - sender + webhook-branch-protection-rule-edited: + title: branch protection rule edited event + type: object + properties: + action: + type: string + enum: + - edited + changes: + description: If the action was `edited`, the changes to the rule. + type: object + properties: + admin_enforced: + type: object + properties: + from: + type: boolean + nullable: true + required: + - from + authorized_actor_names: + type: object + properties: + from: + type: array + items: + type: string + required: + - from + authorized_actors_only: + type: object + properties: + from: + type: boolean + nullable: true + required: + - from + authorized_dismissal_actors_only: + type: object + properties: + from: + type: boolean + nullable: true + required: + - from + linear_history_requirement_enforcement_level: + type: object + properties: + from: + type: string + enum: + - 'off' + - non_admins + - everyone + required: + - from + required_status_checks: + type: object + properties: + from: + type: array + items: + type: string + required: + - from + required_status_checks_enforcement_level: + type: object + properties: + from: + type: string + enum: + - 'off' + - non_admins + - everyone + required: + - from + enterprise: + "$ref": "#/components/schemas/enterprise" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple" + repository: + "$ref": "#/components/schemas/repository" + rule: + title: branch protection rule + description: The branch protection rule. Includes a `name` and all the [branch + protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) + applied to branches that match the name. Binary settings are boolean. + Multi-level configurations are one of `off`, `non_admins`, or `everyone`. + Actor and build lists are arrays of strings. + type: object + properties: + admin_enforced: + type: boolean + allow_deletions_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + allow_force_pushes_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + authorized_actor_names: + type: array + items: + type: string + authorized_actors_only: + type: boolean + authorized_dismissal_actors_only: + type: boolean + create_protected: + type: boolean + created_at: + type: string + format: date-time + dismiss_stale_reviews_on_push: + type: boolean + id: + type: integer + ignore_approvals_from_contributors: + type: boolean + linear_history_requirement_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + merge_queue_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + name: + type: string + pull_request_reviews_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + repository_id: + type: integer + require_code_owner_review: + type: boolean + required_approving_review_count: + type: integer + required_conversation_resolution_level: + type: string + enum: + - 'off' + - non_admins + - everyone + required_deployments_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + required_status_checks: + type: array + items: + type: string + required_status_checks_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + signature_requirement_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + strict_required_status_checks_policy: + type: boolean + updated_at: + type: string + format: date-time + required: + - id + - repository_id + - name + - created_at + - updated_at + - pull_request_reviews_enforcement_level + - required_approving_review_count + - dismiss_stale_reviews_on_push + - require_code_owner_review + - authorized_dismissal_actors_only + - ignore_approvals_from_contributors + - required_status_checks + - required_status_checks_enforcement_level + - strict_required_status_checks_policy + - signature_requirement_enforcement_level + - linear_history_requirement_enforcement_level + - admin_enforced + - allow_force_pushes_enforcement_level + - allow_deletions_enforcement_level + - merge_queue_enforcement_level + - required_deployments_enforcement_level + - required_conversation_resolution_level + - authorized_actors_only + - authorized_actor_names + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - rule + - repository + - sender + webhook-check-run-completed: + title: Check Run Completed Event + type: object + properties: + action: + type: string + enum: + - completed + check_run: + "$ref": "#/components/schemas/check-run-with-simple-check-suite" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple" + repository: + "$ref": "#/components/schemas/repository" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - check_run + - repository + - sender + webhook-check-run-completed-form-encoded: + title: Check Run Completed Event + description: The check_run.completed webhook encoded with URL encoding + type: object + properties: + payload: + description: A URL-encoded string of the check_run.completed JSON payload. + The decoded payload is a JSON object. + type: string + required: + - payload + webhook-check-run-created: + title: Check Run Created Event + type: object + properties: + action: + type: string + enum: + - created + check_run: + "$ref": "#/components/schemas/check-run-with-simple-check-suite" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple" + repository: + "$ref": "#/components/schemas/repository" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - check_run + - repository + - sender + webhook-check-run-created-form-encoded: + title: Check Run Created Event + description: The check_run.created webhook encoded with URL encoding + type: object + properties: + payload: + description: A URL-encoded string of the check_run.created JSON payload. + The decoded payload is a JSON object. + type: string + required: + - payload + webhook-check-suite-completed: + title: check_suite completed event + type: object + properties: + action: + type: string + enum: + - completed + actions_meta: + type: object + nullable: true + check_suite: + description: The [check_suite](https://docs.github.com/rest/reference/checks#suites). + type: object + properties: + after: + type: string + nullable: true + app: + title: App + description: GitHub apps are a new way to extend GitHub. They can be + installed directly on organizations and user accounts and granted + access to specific repositories. They come with granular permissions + and built-in webhooks. GitHub apps are first class actors within GitHub. + type: object + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + - merge_group + - pull_request_review_thread + - workflow_job + - merge_queue_entry + - security_and_analysis + - projects_v2_item + - secret_scanning_alert_location + external_url: + type: string + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + - admin + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + - admin + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + team_discussions: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: string + nullable: true + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + before: + type: string + nullable: true + check_runs_url: + type: string + format: uri + conclusion: + description: The summary conclusion for all check runs that are part + of the check suite. Can be one of `success`, `failure`, `neutral`, + `cancelled`, `timed_out`, `action_required` or `stale`. This value + will be `null` until the check run has `completed`. + type: string + nullable: true + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + - skipped + - startup_failure + created_at: + type: string + format: date-time + head_branch: + description: The head branch name the changes are on. + type: string + nullable: true + head_commit: + title: SimpleCommit + type: object + properties: + author: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: string + nullable: true + format: email + name: + description: The git author's name. + type: string + username: + type: string + required: + - email + - name + committer: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: string + nullable: true + format: email + name: + description: The git author's name. + type: string + username: + type: string + required: + - email + - name + id: + type: string + message: + type: string + timestamp: + type: string + tree_id: + type: string + required: + - id + - tree_id + - message + - timestamp + - author + - committer + head_sha: + description: The SHA of the head commit that is being checked. + type: string + id: + type: integer + latest_check_runs_count: + type: integer + node_id: + type: string + pull_requests: + description: An array of pull requests that match this check suite. + A pull request matches a check suite if they have the same `head_sha` + and `head_branch`. When the check suite's `head_branch` is in a forked + repository it will be `null` and the `pull_requests` array will be + empty. + type: array + items: + title: Check Run Pull Request + type: object + properties: + base: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + head: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + id: + type: integer + number: + type: integer + url: + type: string + format: uri + required: + - url + - id + - number + - head + - base + rerequestable: + type: boolean + runs_rerequestable: + type: boolean + status: + description: The summary status for all check runs that are part of + the check suite. Can be `requested`, `in_progress`, or `completed`. + type: string + nullable: true + enum: + - requested + - in_progress + - completed + - queued + - + - pending + updated_at: + type: string + format: date-time + url: + description: URL that points to the check suite API resource. + type: string + format: uri + required: + - id + - node_id + - head_branch + - head_sha + - status + - conclusion + - url + - before + - after + - pull_requests + - app + - created_at + - updated_at + - latest_check_runs_count + - check_runs_url + - head_commit + enterprise: + "$ref": "#/components/schemas/enterprise" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple" + repository: + "$ref": "#/components/schemas/repository" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - check_suite + - repository + - sender + webhook-code-scanning-alert-appeared-in-branch: + title: code_scanning_alert appeared_in_branch event + type: object + properties: + action: + type: string + enum: + - appeared_in_branch + alert: + description: The code scanning alert involved in the event. + type: object + properties: + created_at: + description: 'The time that the alert was created in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ.`' + type: string + format: date-time + dismissed_at: + description: 'The time that the alert was dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + type: string + nullable: true + format: date-time + dismissed_by: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + dismissed_reason: + description: 'The reason for dismissing or closing the alert. Can be + one of: `false positive`, `won''t fix`, and `used in tests`.' + type: string + nullable: true + enum: + - false positive + - won't fix + - used in tests + - + html_url: + description: The GitHub URL of the alert resource. + type: string + format: uri + instances: + type: array + items: + title: Alert Instance + type: object + nullable: true + properties: + analysis_key: + description: Identifies the configuration under which the analysis + was executed. For example, in GitHub Actions this includes the + workflow filename and job name. + type: string + classifications: + type: array + items: + type: string + commit_sha: + type: string + environment: + description: Identifies the variable values associated with the + environment in which the analysis that generated this alert + instance was performed, such as the language that was analyzed. + type: string + location: + type: object + properties: + end_column: + type: integer + end_line: + type: integer + path: + type: string + start_column: + type: integer + start_line: + type: integer + message: + type: object + properties: + text: + type: string + ref: + description: The full Git reference, formatted as `refs/heads/Hi! This is an area for us to collaborate as a team
" + body_version: 0d495416a700fb06133c612575d92bfb + comments_count: 0 + comments_url: https://api.github.com/teams/2343027/discussions/1/comments + created_at: '2018-01-25T18:56:31Z' + last_edited_at: + html_url: https://github.com/orgs/github/teams/justice-league/discussions/1 + node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ== + number: 1 + pinned: false + private: false + team_url: https://api.github.com/teams/2343027 + title: Our first team post + updated_at: '2018-01-25T18:56:31Z' + url: https://api.github.com/teams/2343027/discussions/1 + reactions: + url: https://api.github.com/teams/2343027/discussions/1/reactions + total_count: 5 + "+1": 3 + "-1": 1 + laugh: 0 + confused: 0 + heart: 1 + hooray: 0 + eyes: 1 + rocket: 1 + team-discussion: + value: + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Hi! This is an area for us to collaborate as a team. + body_html: "Hi! This is an area for us to collaborate as a team
" + body_version: 0d495416a700fb06133c612575d92bfb + comments_count: 0 + comments_url: https://api.github.com/teams/2343027/discussions/1/comments + created_at: '2018-01-25T18:56:31Z' + last_edited_at: + html_url: https://github.com/orgs/github/teams/justice-league/discussions/1 + node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ== + number: 1 + pinned: false + private: false + team_url: https://api.github.com/teams/2343027 + title: Our first team post + updated_at: '2018-01-25T18:56:31Z' + url: https://api.github.com/teams/2343027/discussions/1 + reactions: + url: https://api.github.com/teams/2343027/discussions/1/reactions + total_count: 5 + "+1": 3 + "-1": 1 + laugh: 0 + confused: 0 + heart: 1 + hooray: 0 + eyes: 1 + rocket: 1 + team-discussion-2: + value: + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Hi! This is an area for us to collaborate as a team. + body_html: "Hi! This is an area for us to collaborate as a team
" + body_version: 0d495416a700fb06133c612575d92bfb + comments_count: 1 + comments_url: https://api.github.com/teams/2343027/discussions/1/comments + created_at: '2018-01-25T18:56:31Z' + last_edited_at: '2018-01-26T18:22:20Z' + html_url: https://github.com/orgs/github/teams/justice-league/discussions/1 + node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ== + number: 1 + pinned: false + private: false + team_url: https://api.github.com/teams/2343027 + title: Welcome to our first team post + updated_at: '2018-01-26T18:22:20Z' + url: https://api.github.com/teams/2343027/discussions/1 + reactions: + url: https://api.github.com/teams/2343027/discussions/1/reactions + total_count: 5 + "+1": 3 + "-1": 1 + laugh: 0 + confused: 0 + heart: 1 + hooray: 0 + eyes: 1 + rocket: 1 + team-discussion-comment-items: + value: + - author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Do you like apples? + body_html: "Do you like apples?
" + body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51 + created_at: '2018-01-15T23:53:58Z' + last_edited_at: + discussion_url: https://api.github.com/teams/2403582/discussions/1 + html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= + number: 1 + updated_at: '2018-01-15T23:53:58Z' + url: https://api.github.com/teams/2403582/discussions/1/comments/1 + reactions: + url: https://api.github.com/teams/2403582/discussions/1/reactions + total_count: 5 + "+1": 3 + "-1": 1 + laugh: 0 + confused: 0 + heart: 1 + hooray: 0 + eyes: 1 + rocket: 1 + team-discussion-comment: + value: + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Do you like apples? + body_html: "Do you like apples?
" + body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51 + created_at: '2018-01-15T23:53:58Z' + last_edited_at: + discussion_url: https://api.github.com/teams/2403582/discussions/1 + html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= + number: 1 + updated_at: '2018-01-15T23:53:58Z' + url: https://api.github.com/teams/2403582/discussions/1/comments/1 + reactions: + url: https://api.github.com/teams/2403582/discussions/1/reactions + total_count: 5 + "+1": 3 + "-1": 1 + laugh: 0 + confused: 0 + heart: 1 + hooray: 0 + eyes: 1 + rocket: 1 + team-discussion-comment-2: + value: + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Do you like pineapples? + body_html: "Do you like pineapples?
" + body_version: e6907b24d9c93cc0c5024a7af5888116 + created_at: '2018-01-15T23:53:58Z' + last_edited_at: '2018-01-26T18:22:20Z' + discussion_url: https://api.github.com/teams/2403582/discussions/1 + html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= + number: 1 + updated_at: '2018-01-26T18:22:20Z' + url: https://api.github.com/teams/2403582/discussions/1/comments/1 + reactions: + url: https://api.github.com/teams/2403582/discussions/1/reactions + total_count: 5 + "+1": 3 + "-1": 1 + laugh: 0 + confused: 0 + heart: 1 + hooray: 0 + eyes: 1 + rocket: 1 + reaction-items: + value: + - id: 1 + node_id: MDg6UmVhY3Rpb24x + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + content: heart + created_at: '2016-05-20T20:09:31Z' + reaction: + value: + id: 1 + node_id: MDg6UmVhY3Rpb24x + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + content: heart + created_at: '2016-05-20T20:09:31Z' + team-membership-response-if-user-is-a-team-maintainer: + summary: Response if user is a team maintainer + value: + url: https://api.github.com/teams/1/memberships/octocat + role: maintainer + state: active + team-membership-response-if-users-membership-with-team-is-now-pending: + summary: Response if user's membership with team is now pending + value: + url: https://api.github.com/teams/1/memberships/octocat + role: member + state: pending + team-project-items: + value: + - owner_url: https://api.github.com/orgs/octocat + url: https://api.github.com/projects/1002605 + html_url: https://github.com/orgs/api-playground/projects/1 + columns_url: https://api.github.com/projects/1002605/columns + id: 1002605 + node_id: MDc6UHJvamVjdDEwMDI2MDU= + name: Organization Roadmap + body: High-level roadmap for the upcoming year. + number: 1 + state: open + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2011-04-11T20:09:31Z' + updated_at: '2014-03-04T18:58:10Z' + organization_permission: write + private: false + permissions: + read: true + write: true + admin: false + team-project: + value: + owner_url: https://api.github.com/orgs/octocat + url: https://api.github.com/projects/1002605 + html_url: https://github.com/orgs/api-playground/projects/1 + columns_url: https://api.github.com/projects/1002605/columns + id: 1002605 + node_id: MDc6UHJvamVjdDEwMDI2MDU= + name: Organization Roadmap + body: High-level roadmap for the upcoming year. + number: 1 + state: open + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2011-04-11T20:09:31Z' + updated_at: '2014-03-04T18:58:10Z' + organization_permission: write + private: false + permissions: + read: true + write: true + admin: false + team-repository-alternative-response-with-repository-permissions: + value: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + maintain: false + push: false + triage: false + pull: true + role_name: read + allow_rebase_merge: true + template_repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World-Template + full_name: octocat/Hello-World-Template + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World-Template + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World-Template + archive_url: https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World-Template/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World-Template/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads + events_url: https://api.github.com/repos/octocat/Hello-World-Template/events + forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World-Template.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages + merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} + ssh_url: git@github.com:octocat/Hello-World-Template.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World-Template/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World-Template/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags + teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams + trees_url: https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World-Template.git + mirror_url: git:git.example.com/octocat/Hello-World-Template + hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks + svn_url: https://svn.github.com/octocat/Hello-World-Template + homepage: https://github.com + language: + forks: 9 + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues: 0 + open_issues_count: 0 + is_template: true + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + pull: true + triage: false + push: false + maintain: false + admin: false + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + team-items-response-if-child-teams-exist: + value: + - id: 2 + node_id: MDQ6VGVhbTI= + url: https://api.github.com/teams/2 + name: Original Roster + slug: original-roster + description: Started it all. + privacy: closed + permission: admin + members_url: https://api.github.com/teams/2/members{/member} + repositories_url: https://api.github.com/teams/2/repos + parent: + id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + html_url: https://github.com/orgs/rails/teams/core + project-card: + value: + url: https://api.github.com/projects/columns/cards/1478 + id: 1478 + node_id: MDExOlByb2plY3RDYXJkMTQ3OA== + note: Add payload for delete Project column + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2016-09-05T14:21:06Z' + updated_at: '2016-09-05T14:20:22Z' + archived: false + column_url: https://api.github.com/projects/columns/367 + content_url: https://api.github.com/repos/api-playground/projects-test/issues/3 + project_url: https://api.github.com/projects/120 + project-column: + value: + url: https://api.github.com/projects/columns/367 + project_url: https://api.github.com/projects/120 + cards_url: https://api.github.com/projects/columns/367/cards + id: 367 + node_id: MDEzOlByb2plY3RDb2x1bW4zNjc= + name: To Do + created_at: '2016-09-05T14:18:44Z' + updated_at: '2016-09-05T14:22:28Z' + project-card-items: + value: + - url: https://api.github.com/projects/columns/cards/1478 + id: 1478 + node_id: MDExOlByb2plY3RDYXJkMTQ3OA== + note: Add payload for delete Project column + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2016-09-05T14:21:06Z' + updated_at: '2016-09-05T14:20:22Z' + archived: false + column_url: https://api.github.com/projects/columns/367 + content_url: https://api.github.com/repos/api-playground/projects-test/issues/3 + project_url: https://api.github.com/projects/120 + project-3: + value: + owner_url: https://api.github.com/repos/api-playground/projects-test + url: https://api.github.com/projects/1002604 + html_url: https://github.com/api-playground/projects-test/projects/1 + columns_url: https://api.github.com/projects/1002604/columns + id: 1002604 + node_id: MDc6UHJvamVjdDEwMDI2MDQ= + name: Projects Documentation + body: Developer documentation project for the developer site. + number: 1 + state: open + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + project-collaborator-permission: + value: + permission: admin + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + project-column-items: + value: + - url: https://api.github.com/projects/columns/367 + project_url: https://api.github.com/projects/120 + cards_url: https://api.github.com/projects/columns/367/cards + id: 367 + node_id: MDEzOlByb2plY3RDb2x1bW4zNjc= + name: To Do + created_at: '2016-09-05T14:18:44Z' + updated_at: '2016-09-05T14:22:28Z' + rate-limit-overview: + value: + resources: + core: + limit: 5000 + remaining: 4999 + reset: 1372700873 + used: 1 + search: + limit: 30 + remaining: 18 + reset: 1372697452 + used: 12 + graphql: + limit: 5000 + remaining: 4993 + reset: 1372700389 + used: 7 + integration_manifest: + limit: 5000 + remaining: 4999 + reset: 1551806725 + used: 1 + code_scanning_upload: + limit: 500 + remaining: 499 + reset: 1551806725 + used: 1 + rate: + limit: 5000 + remaining: 4999 + reset: 1372700873 + used: 1 + full-repository-default-response: + summary: Default response + value: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: + forks_count: 9 + forks: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues_count: 0 + open_issues: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + has_discussions: false + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + pull: true + push: false + admin: false + allow_rebase_merge: true + template_repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World-Template + full_name: octocat/Hello-World-Template + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World-Template + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World-Template + archive_url: https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World-Template/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World-Template/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads + events_url: https://api.github.com/repos/octocat/Hello-World-Template/events + forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World-Template.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages + merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} + ssh_url: git@github.com:octocat/Hello-World-Template.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World-Template/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World-Template/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags + teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams + trees_url: https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World-Template.git + mirror_url: git:git.example.com/octocat/Hello-World-Template + hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks + svn_url: https://svn.github.com/octocat/Hello-World-Template + homepage: https://github.com + language: + forks: 9 + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues: 0 + open_issues_count: 0 + is_template: true + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + spdx_id: MIT + url: https://api.github.com/licenses/mit + node_id: MDc6TGljZW5zZW1pdA== + organization: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: Organization + site_admin: false + parent: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + source: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + full-repository: + value: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + language: + forks_count: 9 + forks: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues_count: 0 + open_issues: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + pull: true + push: false + admin: false + allow_rebase_merge: true + template_repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World-Template + full_name: octocat/Hello-World-Template + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World-Template + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World-Template + archive_url: https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World-Template/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World-Template/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads + events_url: https://api.github.com/repos/octocat/Hello-World-Template/events + forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World-Template.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages + merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} + ssh_url: git@github.com:octocat/Hello-World-Template.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World-Template/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World-Template/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags + teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams + trees_url: https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World-Template.git + mirror_url: git:git.example.com/octocat/Hello-World-Template + hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks + svn_url: https://svn.github.com/octocat/Hello-World-Template + homepage: https://github.com + language: + forks: 9 + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues: 0 + open_issues_count: 0 + is_template: true + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + allow_forking: true + web_commit_signoff_required: false + subscribers_count: 42 + network_count: 0 + organization: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: Organization + site_admin: false + parent: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + source: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + artifact-paginated: + value: + total_count: 2 + artifacts: + - id: 11 + node_id: MDg6QXJ0aWZhY3QxMQ== + name: Rails + size_in_bytes: 556 + url: https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11 + archive_download_url: https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip + expired: false + created_at: '2020-01-10T14:59:22Z' + expires_at: '2020-03-21T14:59:22Z' + updated_at: '2020-02-21T14:59:22Z' + workflow_run: + id: 2332938 + repository_id: 1296269 + head_repository_id: 1296269 + head_branch: main + head_sha: 328faa0536e6fef19753d9d91dc96a9931694ce3 + - id: 13 + node_id: MDg6QXJ0aWZhY3QxMw== + name: Test output + size_in_bytes: 453 + url: https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13 + archive_download_url: https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip + expired: false + created_at: '2020-01-10T14:59:22Z' + expires_at: '2020-03-21T14:59:22Z' + updated_at: '2020-02-21T14:59:22Z' + workflow_run: + id: 2332942 + repository_id: 1296269 + head_repository_id: 1296269 + head_branch: main + head_sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 + artifact: + value: + id: 11 + node_id: MDg6QXJ0aWZhY3QxMQ== + name: Rails + size_in_bytes: 556 + url: https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11 + archive_download_url: https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip + expired: false + created_at: '2020-01-10T14:59:22Z' + expires_at: '2020-01-21T14:59:22Z' + updated_at: '2020-01-21T14:59:22Z' + workflow_run: + id: 2332938 + repository_id: 1296269 + head_repository_id: 1296269 + head_branch: main + head_sha: 328faa0536e6fef19753d9d91dc96a9931694ce3 + actions-cache-usage: + value: + full_name: octo-org/Hello-World + active_caches_size_in_bytes: 2322142 + active_caches_count: 3 + actions-cache-list: + value: + total_count: 1 + actions_caches: + - id: 505 + ref: refs/heads/main + key: Linux-node-958aff96db2d75d67787d1e634ae70b659de937b + version: 73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0 + last_accessed_at: '2019-01-24T22:45:36.000Z' + created_at: '2019-01-24T22:45:36.000Z' + size_in_bytes: 1024 + job: + value: + id: 399444496 + run_id: 29679449 + run_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449 + node_id: MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng== + head_sha: f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0 + url: https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496 + html_url: https://github.com/octo-org/octo-repo/runs/399444496 + status: completed + conclusion: success + started_at: '2020-01-20T17:42:40Z' + completed_at: '2020-01-20T17:44:39Z' + name: build + steps: + - name: Set up job + status: completed + conclusion: success + number: 1 + started_at: '2020-01-20T09:42:40.000-08:00' + completed_at: '2020-01-20T09:42:41.000-08:00' + - name: Run actions/checkout@v2 + status: completed + conclusion: success + number: 2 + started_at: '2020-01-20T09:42:41.000-08:00' + completed_at: '2020-01-20T09:42:45.000-08:00' + - name: Set up Ruby + status: completed + conclusion: success + number: 3 + started_at: '2020-01-20T09:42:45.000-08:00' + completed_at: '2020-01-20T09:42:45.000-08:00' + - name: Run actions/cache@v3 + status: completed + conclusion: success + number: 4 + started_at: '2020-01-20T09:42:45.000-08:00' + completed_at: '2020-01-20T09:42:48.000-08:00' + - name: Install Bundler + status: completed + conclusion: success + number: 5 + started_at: '2020-01-20T09:42:48.000-08:00' + completed_at: '2020-01-20T09:42:52.000-08:00' + - name: Install Gems + status: completed + conclusion: success + number: 6 + started_at: '2020-01-20T09:42:52.000-08:00' + completed_at: '2020-01-20T09:42:53.000-08:00' + - name: Run Tests + status: completed + conclusion: success + number: 7 + started_at: '2020-01-20T09:42:53.000-08:00' + completed_at: '2020-01-20T09:42:59.000-08:00' + - name: Deploy to Heroku + status: completed + conclusion: success + number: 8 + started_at: '2020-01-20T09:42:59.000-08:00' + completed_at: '2020-01-20T09:44:39.000-08:00' + - name: Post actions/cache@v3 + status: completed + conclusion: success + number: 16 + started_at: '2020-01-20T09:44:39.000-08:00' + completed_at: '2020-01-20T09:44:39.000-08:00' + - name: Complete job + status: completed + conclusion: success + number: 17 + started_at: '2020-01-20T09:44:39.000-08:00' + completed_at: '2020-01-20T09:44:39.000-08:00' + check_run_url: https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496 + labels: + - self-hosted + - foo + - bar + runner_id: 1 + runner_name: my runner + runner_group_id: 2 + runner_group_name: my runner group + actions-repository-permissions: + value: + enabled: true + allowed_actions: selected + selected_actions_url: https://api.github.com/repositories/42/actions/permissions/selected-actions + actions-workflow-access-to-repository: + value: + access_level: organization + workflow-run-paginated: + value: + total_count: 1 + workflow_runs: + - id: 30433642 + name: Build + node_id: MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ== + check_suite_id: 42 + check_suite_node_id: MDEwOkNoZWNrU3VpdGU0Mg== + head_branch: master + head_sha: acb5820ced9479c074f688cc328bf03f341a511d + run_number: 562 + event: push + status: queued + conclusion: + workflow_id: 159038 + url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642 + html_url: https://github.com/octo-org/octo-repo/actions/runs/30433642 + pull_requests: [] + created_at: '2020-01-22T19:33:08Z' + updated_at: '2020-01-22T19:33:08Z' + actor: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + run_attempt: 1 + run_started_at: '2020-01-22T19:33:08Z' + triggering_actor: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + jobs_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs + logs_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs + check_suite_url: https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374 + artifacts_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts + cancel_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel + rerun_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun + workflow_url: https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038 + head_commit: + id: acb5820ced9479c074f688cc328bf03f341a511d + tree_id: d23f6eedb1e1b9610bbc754ddb5197bfe7271223 + message: Create linter.yaml + timestamp: '2020-01-22T19:33:05Z' + author: + name: Octo Cat + email: octocat@github.com + committer: + name: GitHub + email: noreply@github.com + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + head_repository: + id: 217723378 + node_id: MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg= + name: octo-repo + full_name: octo-org/octo-repo + private: true + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + html_url: https://github.com/octo-org/octo-repo + description: + fork: false + url: https://api.github.com/repos/octo-org/octo-repo + forks_url: https://api.github.com/repos/octo-org/octo-repo/forks + keys_url: https://api.github.com/repos/octo-org/octo-repo/keys{/key_id} + collaborators_url: https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator} + teams_url: https://api.github.com/repos/octo-org/octo-repo/teams + hooks_url: https://api.github.com/repos/octo-org/octo-repo/hooks + issue_events_url: https://api.github.com/repos/octo-org/octo-repo/issues/events{/number} + events_url: https://api.github.com/repos/octo-org/octo-repo/events + assignees_url: https://api.github.com/repos/octo-org/octo-repo/assignees{/user} + branches_url: https://api.github.com/repos/octo-org/octo-repo/branches{/branch} + tags_url: https://api.github.com/repos/octo-org/octo-repo/tags + blobs_url: https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha} + git_tags_url: https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha} + git_refs_url: https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha} + trees_url: https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha} + statuses_url: https://api.github.com/repos/octo-org/octo-repo/statuses/{sha} + languages_url: https://api.github.com/repos/octo-org/octo-repo/languages + stargazers_url: https://api.github.com/repos/octo-org/octo-repo/stargazers + contributors_url: https://api.github.com/repos/octo-org/octo-repo/contributors + subscribers_url: https://api.github.com/repos/octo-org/octo-repo/subscribers + subscription_url: https://api.github.com/repos/octo-org/octo-repo/subscription + commits_url: https://api.github.com/repos/octo-org/octo-repo/commits{/sha} + git_commits_url: https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha} + comments_url: https://api.github.com/repos/octo-org/octo-repo/comments{/number} + issue_comment_url: https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number} + contents_url: https://api.github.com/repos/octo-org/octo-repo/contents/{+path} + compare_url: https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head} + merges_url: https://api.github.com/repos/octo-org/octo-repo/merges + archive_url: https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref} + downloads_url: https://api.github.com/repos/octo-org/octo-repo/downloads + issues_url: https://api.github.com/repos/octo-org/octo-repo/issues{/number} + pulls_url: https://api.github.com/repos/octo-org/octo-repo/pulls{/number} + milestones_url: https://api.github.com/repos/octo-org/octo-repo/milestones{/number} + notifications_url: https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating} + labels_url: https://api.github.com/repos/octo-org/octo-repo/labels{/name} + releases_url: https://api.github.com/repos/octo-org/octo-repo/releases{/id} + deployments_url: https://api.github.com/repos/octo-org/octo-repo/deployments + workflow-run: + value: + id: 30433642 + name: Build + node_id: MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ== + check_suite_id: 42 + check_suite_node_id: MDEwOkNoZWNrU3VpdGU0Mg== + head_branch: main + head_sha: acb5820ced9479c074f688cc328bf03f341a511d + path: ".github/workflows/build.yml@main" + run_number: 562 + event: push + display_title: Update README.md + status: queued + conclusion: + workflow_id: 159038 + url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642 + html_url: https://github.com/octo-org/octo-repo/actions/runs/30433642 + pull_requests: [] + created_at: '2020-01-22T19:33:08Z' + updated_at: '2020-01-22T19:33:08Z' + actor: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + run_attempt: 1 + referenced_workflows: + - path: octocat/Hello-World/.github/workflows/deploy.yml@main + sha: 86e8bc9ecf7d38b1ed2d2cfb8eb87ba9b35b01db + ref: refs/heads/main + - path: octo-org/octo-repo/.github/workflows/report.yml@v2 + sha: 79e9790903e1c3373b1a3e3a941d57405478a232 + ref: refs/tags/v2 + - path: octo-org/octo-repo/.github/workflows/secure.yml@1595d4b6de6a9e9751fb270a41019ce507d4099e + sha: 1595d4b6de6a9e9751fb270a41019ce507d4099e + run_started_at: '2020-01-22T19:33:08Z' + triggering_actor: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + jobs_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs + logs_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs + check_suite_url: https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374 + artifacts_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts + cancel_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel + rerun_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun + previous_attempt_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/attempts/1 + workflow_url: https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038 + head_commit: + id: acb5820ced9479c074f688cc328bf03f341a511d + tree_id: d23f6eedb1e1b9610bbc754ddb5197bfe7271223 + message: Create linter.yaml + timestamp: '2020-01-22T19:33:05Z' + author: + name: Octo Cat + email: octocat@github.com + committer: + name: GitHub + email: noreply@github.com + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + head_repository: + id: 217723378 + node_id: MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg= + name: octo-repo + full_name: octo-org/octo-repo + private: true + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + html_url: https://github.com/octo-org/octo-repo + description: + fork: false + url: https://api.github.com/repos/octo-org/octo-repo + forks_url: https://api.github.com/repos/octo-org/octo-repo/forks + keys_url: https://api.github.com/repos/octo-org/octo-repo/keys{/key_id} + collaborators_url: https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator} + teams_url: https://api.github.com/repos/octo-org/octo-repo/teams + hooks_url: https://api.github.com/repos/octo-org/octo-repo/hooks + issue_events_url: https://api.github.com/repos/octo-org/octo-repo/issues/events{/number} + events_url: https://api.github.com/repos/octo-org/octo-repo/events + assignees_url: https://api.github.com/repos/octo-org/octo-repo/assignees{/user} + branches_url: https://api.github.com/repos/octo-org/octo-repo/branches{/branch} + tags_url: https://api.github.com/repos/octo-org/octo-repo/tags + blobs_url: https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha} + git_tags_url: https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha} + git_refs_url: https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha} + trees_url: https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha} + statuses_url: https://api.github.com/repos/octo-org/octo-repo/statuses/{sha} + languages_url: https://api.github.com/repos/octo-org/octo-repo/languages + stargazers_url: https://api.github.com/repos/octo-org/octo-repo/stargazers + contributors_url: https://api.github.com/repos/octo-org/octo-repo/contributors + subscribers_url: https://api.github.com/repos/octo-org/octo-repo/subscribers + subscription_url: https://api.github.com/repos/octo-org/octo-repo/subscription + commits_url: https://api.github.com/repos/octo-org/octo-repo/commits{/sha} + git_commits_url: https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha} + comments_url: https://api.github.com/repos/octo-org/octo-repo/comments{/number} + issue_comment_url: https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number} + contents_url: https://api.github.com/repos/octo-org/octo-repo/contents/{+path} + compare_url: https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head} + merges_url: https://api.github.com/repos/octo-org/octo-repo/merges + archive_url: https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref} + downloads_url: https://api.github.com/repos/octo-org/octo-repo/downloads + issues_url: https://api.github.com/repos/octo-org/octo-repo/issues{/number} + pulls_url: https://api.github.com/repos/octo-org/octo-repo/pulls{/number} + milestones_url: https://api.github.com/repos/octo-org/octo-repo/milestones{/number} + notifications_url: https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating} + labels_url: https://api.github.com/repos/octo-org/octo-repo/labels{/name} + releases_url: https://api.github.com/repos/octo-org/octo-repo/releases{/id} + deployments_url: https://api.github.com/repos/octo-org/octo-repo/deployments + environment-approvals-items: + value: + - state: approved + comment: Ship it! + environments: + - id: 161088068 + node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 + name: staging + url: https://api.github.com/repos/github/hello-world/environments/staging + html_url: https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging + created_at: '2020-11-23T22:00:40Z' + updated_at: '2020-11-23T22:00:40Z' + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + job-paginated: + value: + total_count: 1 + jobs: + - id: 399444496 + run_id: 29679449 + run_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449 + node_id: MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng== + head_sha: f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0 + url: https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496 + html_url: https://github.com/octo-org/octo-repo/runs/399444496 + status: completed + conclusion: success + started_at: '2020-01-20T17:42:40Z' + completed_at: '2020-01-20T17:44:39Z' + name: build + steps: + - name: Set up job + status: completed + conclusion: success + number: 1 + started_at: '2020-01-20T09:42:40.000-08:00' + completed_at: '2020-01-20T09:42:41.000-08:00' + - name: Run actions/checkout@v2 + status: completed + conclusion: success + number: 2 + started_at: '2020-01-20T09:42:41.000-08:00' + completed_at: '2020-01-20T09:42:45.000-08:00' + - name: Set up Ruby + status: completed + conclusion: success + number: 3 + started_at: '2020-01-20T09:42:45.000-08:00' + completed_at: '2020-01-20T09:42:45.000-08:00' + - name: Run actions/cache@v3 + status: completed + conclusion: success + number: 4 + started_at: '2020-01-20T09:42:45.000-08:00' + completed_at: '2020-01-20T09:42:48.000-08:00' + - name: Install Bundler + status: completed + conclusion: success + number: 5 + started_at: '2020-01-20T09:42:48.000-08:00' + completed_at: '2020-01-20T09:42:52.000-08:00' + - name: Install Gems + status: completed + conclusion: success + number: 6 + started_at: '2020-01-20T09:42:52.000-08:00' + completed_at: '2020-01-20T09:42:53.000-08:00' + - name: Run Tests + status: completed + conclusion: success + number: 7 + started_at: '2020-01-20T09:42:53.000-08:00' + completed_at: '2020-01-20T09:42:59.000-08:00' + - name: Deploy to Heroku + status: completed + conclusion: success + number: 8 + started_at: '2020-01-20T09:42:59.000-08:00' + completed_at: '2020-01-20T09:44:39.000-08:00' + - name: Post actions/cache@v3 + status: completed + conclusion: success + number: 16 + started_at: '2020-01-20T09:44:39.000-08:00' + completed_at: '2020-01-20T09:44:39.000-08:00' + - name: Complete job + status: completed + conclusion: success + number: 17 + started_at: '2020-01-20T09:44:39.000-08:00' + completed_at: '2020-01-20T09:44:39.000-08:00' + check_run_url: https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496 + labels: + - self-hosted + - foo + - bar + runner_id: 1 + runner_name: my runner + runner_group_id: 2 + runner_group_name: my runner group + pending-deployment-items: + value: + - environment: + id: 161088068 + node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 + name: staging + url: https://api.github.com/repos/github/hello-world/environments/staging + html_url: https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging + wait_timer: 30 + wait_timer_started_at: '2020-11-23T22:00:40Z' + current_user_can_approve: true + reviewers: + - type: User + reviewer: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + - type: Team + reviewer: + id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: + deployment-items: + value: + - url: https://api.github.com/repos/octocat/example/deployments/1 + id: 1 + node_id: MDEwOkRlcGxveW1lbnQx + sha: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + ref: topic-branch + task: deploy + payload: {} + original_environment: staging + environment: production + description: Deploy request from hubot + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2012-07-20T01:19:13Z' + updated_at: '2012-07-20T01:19:13Z' + statuses_url: https://api.github.com/repos/octocat/example/deployments/1/statuses + repository_url: https://api.github.com/repos/octocat/example + transient_environment: false + production_environment: true + workflow-run-usage: + value: + billable: + UBUNTU: + total_ms: 180000 + jobs: 1 + job_runs: + - job_id: 1 + duration_ms: 180000 + MACOS: + total_ms: 240000 + jobs: 4 + job_runs: + - job_id: 2 + duration_ms: 60000 + - job_id: 3 + duration_ms: 60000 + - job_id: 4 + duration_ms: 60000 + - job_id: 5 + duration_ms: 60000 + WINDOWS: + total_ms: 300000 + jobs: 2 + job_runs: + - job_id: 6 + duration_ms: 150000 + - job_id: 7 + duration_ms: 150000 + run_duration_ms: 500000 + actions-secret-paginated: + value: + total_count: 2 + secrets: + - name: GH_TOKEN + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + - name: GIST_ID + created_at: '2020-01-10T10:59:22Z' + updated_at: '2020-01-11T11:59:22Z' + actions-secret: + value: + name: GH_TOKEN + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + workflow-paginated: + value: + total_count: 2 + workflows: + - id: 161335 + node_id: MDg6V29ya2Zsb3cxNjEzMzU= + name: CI + path: ".github/workflows/blank.yaml" + state: active + created_at: '2020-01-08T23:48:37.000-08:00' + updated_at: '2020-01-08T23:50:21.000-08:00' + url: https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335 + html_url: https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335 + badge_url: https://github.com/octo-org/octo-repo/workflows/CI/badge.svg + - id: 269289 + node_id: MDE4OldvcmtmbG93IFNlY29uZGFyeTI2OTI4OQ== + name: Linter + path: ".github/workflows/linter.yaml" + state: active + created_at: '2020-01-08T23:48:37.000-08:00' + updated_at: '2020-01-08T23:50:21.000-08:00' + url: https://api.github.com/repos/octo-org/octo-repo/actions/workflows/269289 + html_url: https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289 + badge_url: https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg + workflow: + value: + id: 161335 + node_id: MDg6V29ya2Zsb3cxNjEzMzU= + name: CI + path: ".github/workflows/blank.yaml" + state: active + created_at: '2020-01-08T23:48:37.000-08:00' + updated_at: '2020-01-08T23:50:21.000-08:00' + url: https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335 + html_url: https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335 + badge_url: https://github.com/octo-org/octo-repo/workflows/CI/badge.svg + workflow-usage: + value: + billable: + UBUNTU: + total_ms: 180000 + MACOS: + total_ms: 240000 + WINDOWS: + total_ms: 300000 + autolink-items: + value: + - id: 1 + key_prefix: TICKET- + url_template: https://example.com/TICKET?query=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. + "/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: + 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: Which information the platform needs to collect from + the user. One of `currently_due` or `eventually_due`. Default + is `currently_due`. + enum: + - currently_due + - eventually_due + type: string + 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. Possible + values are `account_onboarding` or `account_update`. + 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. + "/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: + - 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. + post: + description: |- +With Connect, you can create Stripe accounts for your users. + To do this, you’ll first need to register your platform.
+ 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 + documents: + explode: true + style: deepObject + expand: + 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: + type: string + 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: + mcc: + maxLength: 4 + type: string + 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: + maxLength: 5000 + type: string + title: business_profile_specs + type: object + business_type: + description: The business type. + 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 maps to its settings (e.g. whether it has + been requested or not). Each capability will be inactive until + you have provided its specific requirements and Stripe has verified + them. An account may have some of its requested capabilities be + active and some be inactive. + 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 + 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 + 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 + eps_payments: + properties: + requested: + type: boolean + title: capability_param + type: object + fpx_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 + jcb_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 + legacy_payments: + properties: + requested: + type: boolean + title: capability_param + type: object + link_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 + paynow_payments: + properties: + requested: + type: boolean + title: capability_param + type: object + promptpay_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 + 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 + us_bank_account_ach_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`. + 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 + directors_provided: + type: boolean + executives_provided: + type: boolean + 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 + phone: + maxLength: 5000 + type: string + registration_number: + maxLength: 5000 + type: string + structure: + enum: + - '' + - free_zone_establishment + - free_zone_llc + - government_instrumentality + - governmental_unit + - incorporated_non_profit + - limited_liability_partnership + - llc + - multi_member_llc + - private_company + - private_corporation + - private_partnership + - public_company + - public_corporation + - public_partnership + - single_member_llc + - sole_establishment + - sole_proprietorship + - tax_exempt_government_instrumentality + - unincorporated_association + - unincorporated_non_profit + 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 + 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://stripe.com/docs/payouts). + 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_registration: + 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. Stripe only emails + Custom accounts with 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](https://stripe.com/docs/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](https://stripe.com/docs/js), + or a dictionary, as documented in the `external_account` parameter + for [bank account](https://stripe.com/docs/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](https://stripe.com/docs/api#account_create_bank_account) + or [card creation](https://stripe.com/docs/api#account_create_card) + APIs. + maxLength: 5000 + type: string + x-stripeBypassValidation: true + individual: + description: Information about the person represented by the account. + This field is null unless `business_type` is set to `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 + 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: + 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: + maxLength: 5000 + 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 + 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 + weekly_anchor: + enum: + - friday + - monday + - saturday + - sunday + - thursday + - tuesday + - wednesday + maxLength: 5000 + type: string + 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: + maxLength: 5000 + 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](https://stripe.com/docs/connect/updating-accounts#tos-acceptance). + 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.
+ +Accounts created using test-mode keys can be deleted at any time. Standard accounts created using live-mode keys cannot be deleted. Custom or Express accounts created using live-mode keys can only be deleted once all balances are zero.
+ +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. + 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. + post: + description: |- +Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are not supported for Standard accounts.
+ +To update your own account, use the Dashboard. Refer to our Connect 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 + 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: + mcc: + maxLength: 4 + type: string + 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: + maxLength: 5000 + type: string + title: business_profile_specs + type: object + business_type: + description: The business type. + 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 maps to its settings (e.g. whether it has + been requested or not). Each capability will be inactive until + you have provided its specific requirements and Stripe has verified + them. An account may have some of its requested capabilities be + active and some be inactive. + 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 + 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 + 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 + eps_payments: + properties: + requested: + type: boolean + title: capability_param + type: object + fpx_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 + jcb_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 + legacy_payments: + properties: + requested: + type: boolean + title: capability_param + type: object + link_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 + paynow_payments: + properties: + requested: + type: boolean + title: capability_param + type: object + promptpay_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 + 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 + us_bank_account_ach_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`. + 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 + directors_provided: + type: boolean + executives_provided: + type: boolean + 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 + phone: + maxLength: 5000 + type: string + registration_number: + maxLength: 5000 + type: string + structure: + enum: + - '' + - free_zone_establishment + - free_zone_llc + - government_instrumentality + - governmental_unit + - incorporated_non_profit + - limited_liability_partnership + - llc + - multi_member_llc + - private_company + - private_corporation + - private_partnership + - public_company + - public_corporation + - public_partnership + - single_member_llc + - sole_establishment + - sole_proprietorship + - tax_exempt_government_instrumentality + - unincorporated_association + - unincorporated_non_profit + 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 + 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). + 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_registration: + 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. Stripe only emails + Custom accounts with 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](https://stripe.com/docs/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](https://stripe.com/docs/js), + or a dictionary, as documented in the `external_account` parameter + for [bank account](https://stripe.com/docs/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](https://stripe.com/docs/api#account_create_bank_account) + or [card creation](https://stripe.com/docs/api#account_create_card) + APIs. + maxLength: 5000 + type: string + x-stripeBypassValidation: true + individual: + description: Information about the person represented by the account. + This field is null unless `business_type` is set to `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 + 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: + 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: + maxLength: 5000 + 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 + 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 + weekly_anchor: + enum: + - friday + - monday + - saturday + - sunday + - thursday + - tuesday + - wednesday + maxLength: 5000 + type: string + 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: + maxLength: 5000 + 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](https://stripe.com/docs/connect/updating-accounts#tos-acceptance). + 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. + "/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: + type: string + 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: Please refer to full [documentation](https://stripe.com/docs/api) + 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. + "/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 + - 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. + 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 + - 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. + post: + description: |- +Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.
+ +You can re-enable a disabled bank account by performing an update call without providing any arguments 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: + 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 + 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. + "/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. + post: + description: "Updates an existing Account Capability.
" + 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: 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 + 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. + "/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: 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. + 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: + type: string + 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: Please refer to full [documentation](https://stripe.com/docs/api) + 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. + "/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 + - 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. + 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 + - 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. + post: + description: |- +Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.
+ +You can re-enable a disabled bank account by performing an update call without providing any arguments 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: + 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 + 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 single-use login link for an Express account to access their Stripe dashboard.
+ +You may only create login links for Express accounts 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. + "/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: + director: + type: boolean + executive: + 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. + 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: + 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 + verification: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + 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: 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: + maxLength: 500 + type: string + type: array + title: documents_param + type: object + passport: + properties: + files: + items: + maxLength: 500 + type: string + type: array + title: documents_param + type: object + visa: + properties: + files: + items: + maxLength: 500 + 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://stripe.com/docs/js/tokens_sources/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://stripe.com/docs/js/tokens_sources/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://stripe.com/docs/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. + maxLength: 5000 + 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: + director: + type: boolean + executive: + 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 + 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. + "/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.
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. + 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: + 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 + verification: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + 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: 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: + maxLength: 500 + type: string + type: array + title: documents_param + type: object + passport: + properties: + files: + items: + maxLength: 500 + type: string + type: array + title: documents_param + type: object + visa: + properties: + files: + items: + maxLength: 500 + 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://stripe.com/docs/js/tokens_sources/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://stripe.com/docs/js/tokens_sources/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://stripe.com/docs/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. + maxLength: 5000 + 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: + director: + type: boolean + executive: + 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 + 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. + "/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: + director: + type: boolean + executive: + 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. + 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: + 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 + verification: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + 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: 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: + maxLength: 500 + type: string + type: array + title: documents_param + type: object + passport: + properties: + files: + items: + maxLength: 500 + type: string + type: array + title: documents_param + type: object + visa: + properties: + files: + items: + maxLength: 500 + 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://stripe.com/docs/js/tokens_sources/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://stripe.com/docs/js/tokens_sources/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://stripe.com/docs/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. + maxLength: 5000 + 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: + director: + type: boolean + executive: + 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 + 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. + "/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.
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. + 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: + 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 + verification: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + 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: 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: + maxLength: 500 + type: string + type: array + title: documents_param + type: object + passport: + properties: + files: + items: + maxLength: 500 + type: string + type: array + title: documents_param + type: object + visa: + properties: + files: + items: + maxLength: 500 + 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://stripe.com/docs/js/tokens_sources/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://stripe.com/docs/js/tokens_sources/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://stripe.com/docs/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. + maxLength: 5000 + 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: + director: + type: boolean + executive: + 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 + 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. + "/v1/accounts/{account}/reject": + post: + description: |- +With Connect, you may flag accounts as suspicious.
+ +Test-mode Custom and Express accounts can be rejected at any time. Accounts created using live-mode keys may only be rejected once 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. + "/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 + - 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. + "/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. + post: + description: |- +Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+ +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. + "/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. + "/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.
Refunds an application fee that has previously been collected but not yet refunded. + Funds will be refunded to the Stripe account from which the fee was originally collected.
+ +You can optionally refund only part of an application fee. + You can do so multiple times, until the entire fee has been refunded.
+ +Once entirely refunded, an application fee can’t be refunded again. + This method will raise an error when called on an already-refunded application fee, + or 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. + "/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. + 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. + "/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. + "/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. + "/v1/balance": + get: + description: |- +Retrieves the current account balance, based on the authentication that was used to make the request. + 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. + "/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.
+ +Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.
Retrieves the balance transaction with the given ID.
+ +Note that this endpoint previously used the path /v1/balance/history/:id.
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.
+ +Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.
Retrieves the balance transaction with the given ID.
+ +Note that this endpoint previously used the path /v1/balance/history/:id.
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: PortalConfigurationList + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + "$ref": "#/components/schemas/error" + description: Error response. + 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 + schema: + additionalProperties: false + properties: + business_profile: + description: The business information shown to customers in the + portal. + properties: + headline: + maxLength: 60 + 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 + - 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_pause: + properties: + enabled: + type: boolean + title: subscription_pause_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: + 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 + required: + - default_allowed_updates + - enabled + - products + 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 + required: + - business_profile + - 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. + "/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. + 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 + 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: + maxLength: 60 + 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 + - 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_pause: + properties: + enabled: + type: boolean + title: subscription_pause_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: + 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 + 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`. + 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. + "/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 + 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 + 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/charges-transfers#on-behalf-of). + 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. + "/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: + - 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. + 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. + post: + description: "To charge a credit card or other payment source, you create
+ a Charge object. If your API key is in test mode, the supplied
+ payment source (e.g., card) won’t actually be charged, although everything
+ else will occur as if in live mode. (Stripe assumes that the charge would
+ have completed successfully).
Search for charges you’ve previously created using Stripe’s Search Query Language. + Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating + conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up + to 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. + "/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. + 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/charges-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. + "/v1/charges/{charge}/capture": + post: + description: |- +Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step payment flow, where first you created a charge with the capture option set to false.
+ +Uncaptured payments expire a set number of days after they are created (7 by default). If they are not captured by that point in time, they will be marked as refunded and will no longer be capturable.
+ 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. Any additional amount will be automatically + refunded. + 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 card charges, use `statement_descriptor_suffix` + instead. Otherwise, you can use this value as the complete description + of a charge on your customers’ statements. Must contain at least + one letter, maximum 22 characters. + maxLength: 22 + type: string + statement_descriptor_suffix: + description: Provides information about the charge 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: 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/charges-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. + "/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 + 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 a Charge or a PaymentIntent object on which to create it.
+ +Creating a new refund will refund a charge that has previously been created but not yet refunded. + Funds will be refunded to the credit or debit card that was originally charged.
+ +You can optionally refund only part of a charge. + You can do so multiple times, until the entire charge has been refunded.
+ +Once entirely refunded, a charge can’t be refunded again. + This method will raise an error when called on an already-refunded charge, + or when trying to refund more money than is left on a charge.
+ operationId: PostChargesChargeRefund + 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 + metadata: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + amount: + type: integer + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + instructions_email: + 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: + maxLength: 5000 + type: string + reason: + enum: + - duplicate + - fraudulent + - requested_by_customer + maxLength: 5000 + type: string + refund_application_fee: + type: boolean + reverse_transfer: + 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. + "/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.
Create a refund.
" + operationId: PostChargesChargeRefunds + 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 + metadata: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + amount: + description: A positive integer representing how much to refund. + 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 + 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: Address to send refund email, use customer email if + not specified + 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: + maxLength: 5000 + type: string + reason: + enum: + - duplicate + - fraudulent + - requested_by_customer + maxLength: 5000 + type: string + refund_application_fee: + type: boolean + reverse_transfer: + 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. + "/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 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: 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 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. + post: + description: "Creates a Session object.
" + operationId: PostCheckoutSessions + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + after_expiration: + explode: true + style: deepObject + automatic_tax: + explode: true + style: deepObject + consent_collection: + explode: true + style: deepObject + customer_update: + 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_intent_data: + explode: true + style: deepObject + payment_method_options: + explode: true + style: deepObject + payment_method_types: + explode: true + style: deepObject + phone_number_collection: + 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 + schema: + additionalProperties: false + properties: + 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 + required: + - enabled + title: automatic_tax_params + type: object + billing_address_collection: + description: Specify whether Checkout should collect the customer's + billing address. + enum: + - auto + - required + type: string + cancel_url: + description: The URL the customer will be directed to if they decide + to cancel payment and return to your website. + maxLength: 5000 + type: string + client_reference_id: + description: |- + A unique string to reference the Checkout Session. This can be a + customer ID, a cart ID, or similar, and can be used to reconcile the + session with your internal systems. + maxLength: 200 + type: string + consent_collection: + description: Configure fields for the Checkout Session to gather + active consent from customers. + properties: + 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). + type: string + customer: + description: |- + ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recent card + payment method will be used to prefill the email, name, card details, and billing address + on 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) + will be used if it’s a card, and otherwise the most recent 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. + + If 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. + If the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer. + + If blank for Checkout Sessions in `payment` or `subscription` mode, Checkout will create a new Customer object based on information provided during the payment flow. + + You 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. + + When a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout + with [customer_details](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-customer_details). + + Sessions that don't create Customers instead create [Guest Customers](https://support.stripe.com/questions/guest-customer-faq) + in the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions. + + Can 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. + If not provided, customers will be asked to enter their email address. + Use this parameter to prefill customer data if you already have an email + on file. To access information about the customer once a session is + complete, 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 + 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). + + For `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. + + For `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: + 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 + 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 + - 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. + This may occur if the Checkout Session includes a free trial or a discount. + + Can only be set in `subscription` mode. + + If 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_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 + 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 + au_becs_debit: + properties: + setup_future_usage: + enum: + - none + type: string + title: payment_method_options_param + type: object + bacs_debit: + properties: + setup_future_usage: + enum: + - none + - off_session + - on_session + 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 + 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 + 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: + - iban + - sepa + - 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 + 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 + klarna: + properties: + setup_future_usage: + enum: + - none + 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 + 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 + paynow: + properties: + setup_future_usage: + enum: + - none + type: string + tos_shown_and_accepted: + type: boolean + title: payment_method_options_param + type: object + pix: + properties: + expires_after_seconds: + type: integer + title: payment_method_options_param + type: object + sepa_debit: + properties: + setup_future_usage: + enum: + - none + - off_session + - on_session + 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 + us_bank_account: + properties: + financial_connections: + properties: + permissions: + items: + enum: + - balances + - ownership + - payment_method + - transactions + maxLength: 5000 + 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 + 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. + + In `payment` and `subscription` mode, you can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). + It is required in `setup` mode. + + Read more about the supported payment methods and their requirements in our [payment + method details guide](/docs/payments/checkout/payment-methods). + + If multiple payment methods are passed, Checkout will dynamically reorder them to + prioritize the most relevant payment methods based on the customer's location and + other characteristics. + items: + enum: + - acss_debit + - affirm + - afterpay_clearpay + - alipay + - au_becs_debit + - bacs_debit + - bancontact + - blik + - boleto + - card + - customer_balance + - eps + - fpx + - giropay + - grabpay + - ideal + - klarna + - konbini + - oxxo + - p24 + - paynow + - pix + - promptpay + - sepa_debit + - sofort + - us_bank_account + - wechat_pay + type: string + x-stripeBypassValidation: true + type: array + phone_number_collection: + description: |- + Controls phone number collection settings for the session. + + We recommend that you review your privacy policy and check with your legal contacts + before 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 + 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 + - 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. + 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: + 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 to customize + relevant text on the page, such as the submit button. `submit_type` can only be + specified on Checkout Sessions in `payment` mode, but not Checkout Sessions + in `subscription` or `setup` mode. + enum: + - auto + - book + - donate + - pay + 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 + default_tax_rates: + items: + maxLength: 5000 + type: string + type: array + description: + maxLength: 500 + type: string + metadata: + additionalProperties: + type: string + type: object + on_behalf_of: + 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 + title: subscription_data_params + type: object + success_url: + description: |- + The URL to which Stripe should send customers when payment or setup + is complete. + If you’d like to use information from the successful Checkout Session on your page, + read the guide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page). + maxLength: 5000 + type: string + tax_id_collection: + description: Controls tax ID collection settings for the session. + properties: + enabled: + type: boolean + required: + - enabled + title: tax_id_collection_params + type: object + required: + - cancel_url + - success_url + type: object + required: true + 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. + "/v1/checkout/sessions/{session}": + get: + description: "Retrieves a 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. + "/v1/checkout/sessions/{session}/expire": + post: + description: |- +A Session can be expired when it is in one of these statuses: open
After it expires, a customer can’t complete a Session and customers loading the Session see a message saying the 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. + "/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. + "/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. + "/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. + "/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. + 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.
+ +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 amount_off of amount_off of
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. + 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. + 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. + "/v1/credit_notes": + get: + description: "Returns a list of credit notes.
" + operationId: GetCreditNotes + parameters: + - 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. + post: + description: |- +Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces
+ its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result
+ in any combination of the following:
-
+
- Refund: create a new refund (using
refund_amount) or link an existing refund (usingrefund).
+ - Customer balance credit: credit the customer’s balance (using
credit_amount) which will be automatically applied to their next invoice when it’s finalized.
+ - Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using
out_of_band_amount).
+
For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total.
+ +You may issue multiple credit notes for an invoice. Each credit note will increment the invoice’s pre_payment_credit_notes_amount
+ or post_payment_credit_notes_amount depending on its status at the time of credit note creation.
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. + 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: Specifies which fields in 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. + 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_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: ID of an existing refund to link this credit note to. + in: query + name: refund + required: false + schema: + 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 + requestBody: + 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. + "/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. + 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: 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. + 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_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: ID of an existing refund to link this credit note to. + in: query + name: refund + required: false + schema: + 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: 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. + "/v1/credit_notes/{credit_note}/lines": + get: + description: "When retrieving a credit note, you’ll get a lines + property containing the 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. + "/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. + 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. + "/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. + "/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: + - 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. + 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_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 + type: string + title: balance_settings_param + type: object + title: cash_balance_param + type: object + coupon: + maxLength: 5000 + 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: 30 + type: string + value: + maxLength: 30 + 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 + title: 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 + promotion_code: + description: The API ID of a promotion code to apply to the customer. + The customer will have a discount applied on all recurring payments. + Charges you create through the API will not have the discount. + maxLength: 5000 + 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 + 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 + title: tax_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: + - ae_trn + - au_abn + - au_arn + - bg_uic + - br_cnpj + - br_cpf + - ca_bn + - ca_gst_hst + - ca_pst_bc + - ca_pst_mb + - ca_pst_sk + - ca_qst + - ch_vat + - cl_tin + - eg_tin + - es_cif + - eu_oss_vat + - eu_vat + - gb_vat + - ge_vat + - hk_br + - hu_tin + - id_npwp + - il_vat + - in_gst + - is_vat + - jp_cn + - jp_rn + - jp_trn + - ke_pin + - kr_brn + - li_uid + - mx_rfc + - my_frp + - my_itn + - my_sst + - no_vat + - nz_gst + - ph_tin + - ru_inn + - ru_kpp + - sa_vat + - sg_gst + - sg_uen + - si_tin + - th_vat + - tr_tin + - tw_vat + - ua_vat + - us_ein + - za_vat + 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. + "/v1/customers/search": + get: + description: |- +Search for customers you’ve previously created using Stripe’s Search Query Language. + Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating + conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up + to 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. + "/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. + 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. + 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.
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_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: + 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 + type: string + title: balance_settings_param + type: object + title: cash_balance_param + type: object + coupon: + maxLength: 5000 + type: string + 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. + + Provide the ID of a payment source already attached to this customer to make it this customer's default payment source. + + If 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: 30 + type: string + value: + maxLength: 30 + 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 + title: 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 + promotion_code: + description: The API ID of a promotion code to apply to the customer. + The customer will have a discount applied on all recurring payments. + Charges you create through the API will not have the discount. + maxLength: 5000 + 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 + 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 + title: tax_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. + "/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. + 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. + 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. + "/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. + post: + description: "Most credit balance transaction fields are immutable, but you
+ may update its description and metadata.
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.
When you create a new credit card, you must specify a customer or recipient on which to create it.
+ +If the card’s owner has no default card, then the new card will become the default.
+ However, if the owner already has a default, then it will not change.
+ To change the default, you should update the customer to have a new default_source.
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. + 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. + 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. + "/v1/customers/{customer}/cards": + get: + deprecated: true + description: |- +You can see a list of the cards belonging to a customer.
+ Note that the 10 most recent sources are always available on the Customer 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 cards.
When you create a new credit card, you must specify a customer or recipient on which to create it.
+ +If the card’s owner has no default card, then the new card will become the default.
+ However, if the owner already has a default, then it will not change.
+ To change the default, you should update the customer to have a new default_source.
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. + 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. + 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. + 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 + 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. + "/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 + by the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions + represent when funds are moved into or out of this balance. This includes funding by the customer, allocation + to 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. + "/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. + "/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. + 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 + funding instructions will be created. If funding instructions have already been created for a given customer, the same + funding 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 + 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). + 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. + "/v1/customers/{customer}/payment_methods": + get: + description: "Returns a list of PaymentMethods for a given Customer
" + operationId: GetCustomersCustomerPaymentMethods + 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 + - description: A required filter on the list, based on the object `type` field. + in: query + name: type + required: true + schema: + enum: + - acss_debit + - affirm + - afterpay_clearpay + - alipay + - au_becs_debit + - bacs_debit + - bancontact + - blik + - boleto + - card + - customer_balance + - eps + - fpx + - giropay + - grabpay + - ideal + - klarna + - konbini + - link + - oxxo + - p24 + - paynow + - pix + - promptpay + - sepa_debit + - sofort + - us_bank_account + - wechat_pay + 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. + "/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. + "/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.
+ +If the card’s owner has no default card, then the new card will become the default.
+ However, if the owner already has a default, then it will not change.
+ To change the default, you should update the customer to have a new default_source.
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. + 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. + "/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. + 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 + automatic_tax: + explode: true + style: deepObject + billing_thresholds: + explode: true + style: deepObject + default_tax_rates: + explode: true + style: deepObject + expand: + 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 + 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: + price: + maxLength: 5000 + type: string + price_data: + properties: + 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_rates: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + title: add_invoice_item_entry + type: object + 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 subtotal 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 subscription. We recommend + you only include this parameter when the existing value is being + changed. + properties: + enabled: + type: boolean + required: + - enabled + title: automatic_tax_config + type: object + backdate_start_date: + description: For new subscriptions, a past timestamp to backdate + the subscription's start date to. If set, the first invoice will + contain a proration 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 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. The timestamp is in UTC format. + 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. Pass an + empty string to remove previously-defined thresholds. + cancel_at: + 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. + format: unix-time + type: integer + cancel_at_period_end: + description: Boolean indicating whether this subscription should + cancel at the end of the current period. + 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 + coupon: + description: The ID of the coupon to apply to this subscription. + A coupon applied to a subscription will only affect invoices created + for that particular subscription. + 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). + 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. + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + 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 + metadata: + additionalProperties: + type: string + type: object + price: + maxLength: 5000 + type: string + price_data: + properties: + 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. + type: boolean + payment_behavior: + description: |- + Only applies to subscriptions with `collection_method=charge_automatically`. + + Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid. Creating subscriptions with this status 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. + + Use `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 payment intent on the first invoice. 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. If the payment intent is not confirmed within 23 hours subscriptions transition to `status=incomplete_expired`, which is a terminal state. + + Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first 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 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. + + `pending_if_incomplete` is only used with updates and cannot be passed when creating a subscription. + + Subscriptions 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 + - interac + - jcb + - mastercard + - unionpay + - unknown + - visa + maxLength: 5000 + type: string + x-stripeBypassValidation: true + request_three_d_secure: + enum: + - any + - automatic + 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 + us_bank_account: + anyOf: + - properties: + financial_connections: + properties: + permissions: + items: + enum: + - balances + - ownership + - payment_method + - transactions + maxLength: 5000 + 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 + - au_becs_debit + - bacs_debit + - bancontact + - boleto + - card + - customer_balance + - fpx + - giropay + - grabpay + - ideal + - konbini + - link + - paynow + - promptpay + - sepa_debit + - sofort + - 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. + promotion_code: + description: The API ID of a promotion code to apply to this subscription. + A promotion code applied to a subscription will only affect invoices + created for that particular subscription. + maxLength: 5000 + type: string + proration_behavior: + description: Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. + 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`. 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 + 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. + "/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.
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.
+ +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. + 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. + 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 + 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 + expand: + 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 + 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: + price: + maxLength: 5000 + type: string + price_data: + properties: + 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_rates: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + title: add_invoice_item_entry + type: object + 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 subtotal 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 subscription. We recommend + you only include this parameter when the existing value is being + changed. + properties: + enabled: + type: boolean + 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. Pass an + empty string to remove previously-defined thresholds. + cancel_at: + anyOf: + - format: unix-time + type: integer + - enum: + - '' + 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: Boolean indicating whether this subscription should + cancel at the end of the current period. + 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 + coupon: + description: The ID of the coupon to apply to this subscription. + A coupon applied to a subscription will only affect invoices created + for that particular subscription. + 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. Pass + an empty string to remove previously-defined tax rates. + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + 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 + id: + maxLength: 5000 + type: string + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - enum: + - '' + type: string + price: + maxLength: 5000 + type: string + price_data: + properties: + 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. + 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. + 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. + + Use `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. + + Use `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). + + Use `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://stripe.com/docs/upgrades#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 + - interac + - jcb + - mastercard + - unionpay + - unknown + - visa + maxLength: 5000 + type: string + x-stripeBypassValidation: true + request_three_d_secure: + enum: + - any + - automatic + 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 + us_bank_account: + anyOf: + - properties: + financial_connections: + properties: + permissions: + items: + enum: + - balances + - ownership + - payment_method + - transactions + maxLength: 5000 + 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 + - au_becs_debit + - bacs_debit + - bancontact + - boleto + - card + - customer_balance + - fpx + - giropay + - grabpay + - ideal + - konbini + - link + - paynow + - promptpay + - sepa_debit + - sofort + - 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. + promotion_code: + description: The promotion code to apply to this subscription. A + promotion code applied to a subscription will only affect invoices + created for that particular subscription. + maxLength: 5000 + type: string + proration_behavior: + description: Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. + 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 exactly the same proration that was previewed with [upcoming + invoice](https://stripe.com/docs/api#retrieve_customer_invoice) + endpoint. It 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 + 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. + "/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. + 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. + post: + description: "Creates a new TaxID object for a customer.
Deletes an existing TaxID object.
Retrieves the TaxID object with the given identifier.
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 + - 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. + "/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. + 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.
+ +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 + 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/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.
+ +The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.
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 + 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. + "/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. + "/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).
Retrieves the details of an event. 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. + "/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. + "/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. + "/v1/file_links": + get: + description: "Returns a list of file links.
" + operationId: GetFileLinks + parameters: + - 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, all links + are returned. + 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: FileFileLinkList + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + "$ref": "#/components/schemas/error" + description: Error response. + 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: A future timestamp after which the link will no longer + be usable. + 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`, `identity_document_downloadable`, + `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, + 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. + "/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. + 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. + "/v1/files": + get: + description: "Returns a list of the files that your account has access to. + The files are returned sorted by creation date, with the most recently created + files appearing first.
" + operationId: GetFiles + parameters: + - 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: The file purpose to filter queries by. If none is provided, files + will not be filtered by purpose. + 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 + - identity_document + - identity_document_downloadable + - pci_document + - selfie + - sigma_scheduled_query + - tax_document_user_upload + - 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: FileFileList + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + "$ref": "#/components/schemas/error" + description: Error response. + post: + description: |- +To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.
All of Stripe’s officially supported Client libraries should have support for sending multipart/form-data.
Retrieves the details of an existing file object. Supply the + unique file ID from a file, and Stripe will return the corresponding file + object. To access file contents, see the File + Upload Guide.
+ 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. + "/v1/financial_connections/accounts": + get: + description: "Returns a list of Financial Connections Account
+ objects.
Retrieves the details of an Financial Connections Account.
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).
Lists all owners for a given Account
Refreshes the data associated with a Financial Connections
+ Account.
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.
Retrieves the details of a Financial Connections Session
List all verification reports.
" + operationId: GetIdentityVerificationReports + parameters: + - 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. + "/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. + "/v1/identity/verification_sessions": + get: + description: "Returns a list of VerificationSessions
" + operationId: GetIdentityVerificationSessions + parameters: + - 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 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. + post: + description: |- +Creates a VerificationSession object.
+ +After the VerificationSession is created, display a verification modal using the session client_secret or send your users to the session’s url.
If your API key is in test mode, verification checks won’t actually process, though everything else will occur as if in live mode.
+ +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 + 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 + 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. + enum: + - document + - id_number + type: string + x-stripeBypassValidation: true + required: + - type + type: object + required: true + 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. + "/v1/identity/verification_sessions/{session}": + get: + description: |- +Retrieves the details of a VerificationSession that was previously created.
+ +When the session status is requires_input, you can use this method to retrieve a valid
+ client_secret or url to allow re-submission.
Updates a VerificationSession object.
+ +When the session status is requires_input, you can use this method to update the
+ verification check and options.
A VerificationSession object can be canceled when it is in requires_input status.
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. + "/v1/identity/verification_sessions/{session}/redact": + post: + description: |- +Redact a VerificationSession to remove all collected information from Stripe. This will redact + the VerificationSession and all objects related to it, including VerificationReports, Events, + request logs, etc.
+ +A VerificationSession object can be redacted when it is in requires_input or verified
+ status. Redacting a VerificationSession in requires_action
+ state will automatically cancel it.
The redaction process may take up to four days. When the redaction process is in progress, the
+ VerificationSession’s redaction.status field will be set to processing; when the process is
+ finished, it will change to redacted and an identity.verification_session.redacted event
+ will be emitted.
Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the
+ fields that contain personal data will be replaced by the string [redacted] or a similar
+ placeholder. The metadata field will also be erased. Redacted objects cannot be updated or
+ used for any purpose.
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: + - 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. + 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 + 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). + 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 + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string + description: The coupons 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. When left blank, the invoice item will be added to the next + upcoming scheduled 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. + properties: + end: + format: unix-time + type: integer + start: + format: unix-time + type: integer + required: + - end + - start + title: period + type: object + 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: + 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: + 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 will be be 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: 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: + 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. Passing + in a negative `unit_amount` will reduce the `amount_due` on the + invoice. + 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: + - 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. + "/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. + 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. + 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 + 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 + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string + description: The coupons & 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. + properties: + end: + format: unix-time + type: integer + start: + format: unix-time + type: integer + required: + - end + - start + title: period + type: object + 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: + 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: + description: Non-negative integer. The quantity of units for the + invoice item. + type: integer + tax_behavior: + description: 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: + 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 + 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. + "/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 + - 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 + maxLength: 5000 + 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: InvoicesList + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + "$ref": "#/components/schemas/error" + description: Error response. + 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 + metadata: + explode: true + style: deepObject + payment_settings: + explode: true + style: deepObject + rendering_options: + 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 will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) + of the invoice. When `false`, the invoice's state will not automatically + advance without an explicit action. + type: boolean + automatic_tax: + description: Settings for automatic tax lookup for this invoice. + properties: + enabled: + type: boolean + 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 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. + type: string + custom_fields: + anyOf: + - items: + properties: + name: + maxLength: 30 + type: string + value: + maxLength: 30 + 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 + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string + description: The coupons 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 + 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 + 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 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: + maxLength: 5000 + 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: + - fixed_count + type: string + required: + - count + - interval + - type + title: installment_plan + type: object + - enum: + - '' + type: string + title: installments_param + type: object + request_three_d_secure: + enum: + - any + - automatic + 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 + us_bank_account: + anyOf: + - properties: + financial_connections: + properties: + permissions: + items: + enum: + - balances + - ownership + - payment_method + - transactions + maxLength: 5000 + 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 + - au_becs_debit + - bacs_debit + - bancontact + - boleto + - card + - customer_balance + - fpx + - giropay + - grabpay + - ideal + - konbini + - link + - paynow + - promptpay + - sepa_debit + - sofort + - 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. + One of `include` or `exclude`. `include` will include any pending + invoice items, and will create an empty draft invoice if no pending + invoice items exist. `exclude` will always create an empty invoice + draft regardless if there are pending invoice items or not. Defaults + to `exclude` if the parameter is omitted. + enum: + - exclude + - include + - include_and_require + type: string + rendering_options: + anyOf: + - properties: + amount_tax_display: + enum: + - '' + - exclude_tax + - include_inclusive_tax + type: string + title: rendering_options_param + type: object + - enum: + - '' + type: string + description: Options for invoice PDF rendering. + 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 and pending invoice items not associated with + any subscription if `pending_invoice_items_behavior` is `include`. + 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. + "/v1/invoices/search": + get: + description: |- +Search for invoices you’ve previously created using Stripe’s Search Query Language. + Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating + conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up + to 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. + "/v1/invoices/upcoming": + get: + description: |- +At any time, you can preview the upcoming invoice for a customer. 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.
+ +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.
+ +You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass a proration_date parameter when doing the actual subscription update. The value passed in should be the same as the subscription_proration_date returned on the upcoming invoice resource. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_proration_date on the upcoming invoice resource.
When retrieving an upcoming 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: GetInvoicesUpcomingLines + parameters: + - description: Settings for automatic tax lookup for this invoice preview. + explode: true + in: query + name: automatic_tax + required: false + schema: + properties: + enabled: + type: boolean + required: + - enabled + title: automatic_tax_param + type: object + style: deepObject + - description: The code of the coupon to apply. If `subscription` or `subscription_items` + is provided, the invoice returned will preview updating or creating a subscription + with that coupon. Otherwise, it will preview applying that coupon to the + customer for the next upcoming invoice from among the customer's subscriptions. + The invoice can be previewed without a coupon by passing this value as an + empty string. + in: query + name: coupon + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: The currency to preview this invoice in. Defaults to that of + `customer` if not specified. + in: query + name: currency + required: false + schema: + type: string + style: form + - description: The identifier of the customer whose upcoming invoice you'd like + to retrieve. + in: query + name: customer + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Details about the customer you want to invoice or overrides for + an existing customer. + explode: true + in: query + name: customer_details + required: false + schema: + 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_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: + - ae_trn + - au_abn + - au_arn + - bg_uic + - br_cnpj + - br_cpf + - ca_bn + - ca_gst_hst + - ca_pst_bc + - ca_pst_mb + - ca_pst_sk + - ca_qst + - ch_vat + - cl_tin + - eg_tin + - es_cif + - eu_oss_vat + - eu_vat + - gb_vat + - ge_vat + - hk_br + - hu_tin + - id_npwp + - il_vat + - in_gst + - is_vat + - jp_cn + - jp_rn + - jp_trn + - ke_pin + - kr_brn + - li_uid + - mx_rfc + - my_frp + - my_itn + - my_sst + - no_vat + - nz_gst + - ph_tin + - ru_inn + - ru_kpp + - sa_vat + - sg_gst + - sg_uen + - si_tin + - th_vat + - tr_tin + - tw_vat + - ua_vat + - us_ein + - za_vat + 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 + style: deepObject + - description: The coupons to redeem into discounts for the invoice preview. + If not specified, inherits the discount from the customer or subscription. + This only works for coupons directly applied to the invoice. To apply a + coupon to a subscription, you must use the `coupon` parameter instead. Pass + an empty string to avoid inheriting any discounts. To preview the upcoming + invoice for a subscription that hasn't been created, use `coupon` instead. + explode: true + in: query + name: discounts + required: false + schema: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - 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: List of invoice items to add or update in the upcoming invoice + preview. + explode: true + in: query + name: invoice_items + required: false + schema: + items: + properties: + amount: + type: integer + 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 + 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: + 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 + 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 identifier of the unstarted schedule whose upcoming invoice + you'd like to retrieve. Cannot be used with subscription or subscription + fields. + in: query + name: schedule + 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 identifier of the subscription for which you'd like to retrieve + the upcoming invoice. If not provided, but a `subscription_items` is provided, + you will preview creating a subscription with those items. If neither `subscription` + nor `subscription_items` is provided, you will retrieve the next upcoming + invoice from among the customer's subscriptions. + in: query + name: subscription + required: false + schema: + maxLength: 5000 + type: string + style: form + - 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`. + explode: true + in: query + name: subscription_billing_cycle_anchor + required: false + schema: + anyOf: + - enum: + - now + - unchanged + maxLength: 5000 + type: string + - format: unix-time + type: integer + style: deepObject + - description: Timestamp indicating when the subscription should be scheduled + to cancel. Will prorate if within the current period and prorations have + been enabled using `proration_behavior`. + explode: true + in: query + name: subscription_cancel_at + required: false + schema: + anyOf: + - format: unix-time + type: integer + - enum: + - '' + type: string + style: deepObject + - description: Boolean indicating whether this subscription should cancel at + the end of the current period. + in: query + name: subscription_cancel_at_period_end + required: false + schema: + type: boolean + style: form + - description: This simulates the subscription being canceled or expired immediately. + in: query + name: subscription_cancel_now + required: false + schema: + type: boolean + style: form + - 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. + explode: true + in: query + name: subscription_default_tax_rates + required: false + schema: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + style: deepObject + - description: A list of up to 20 subscription items, each with an attached + price. + explode: true + in: query + name: subscription_items + required: false + schema: + 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 + id: + maxLength: 5000 + type: string + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - enum: + - '' + type: string + price: + maxLength: 5000 + type: string + price_data: + properties: + 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 + style: deepObject + - description: Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. + in: query + name: subscription_proration_behavior + required: false + schema: + enum: + - always_invoice + - create_prorations + - none + type: string + style: form + - description: If previewing an update to a subscription, and doing proration, + `subscription_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 cannot be before the subscription was + on its current plan. If set, `subscription`, and one of `subscription_items`, + or `subscription_trial_end` are required. Also, `subscription_proration_behavior` + cannot be set to 'none'. + in: query + name: subscription_proration_date + required: false + schema: + format: unix-time + type: integer + style: form + - description: Date a subscription is intended to start (can be future or past) + in: query + name: subscription_start_date + required: false + schema: + format: unix-time + type: integer + style: form + - description: If provided, the invoice returned will preview updating or creating + a subscription with that trial end. If set, one of `subscription_items` + or `subscription` is required. + explode: true + in: query + name: subscription_trial_end + required: false + schema: + anyOf: + - enum: + - now + maxLength: 5000 + type: string + - format: unix-time + type: integer + style: deepObject + - description: Indicates if a plan's `trial_period_days` should be applied to + the subscription. Setting `subscription_trial_end` per subscription is preferred, + and this defaults to `false`. Setting this flag to `true` together with + `subscription_trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) + to learn more. + in: query + name: subscription_trial_from_plan + required: false + schema: + type: boolean + style: 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. + "/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. + 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. + post: + description: |- +Draft invoices are fully editable. Once an invoice is finalized,
+ monetary values, as well as collection_method, become uneditable.
If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on,
+ sending reminders for, or automatically reconciling invoices, pass
+ auto_advance=false.
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 will perform [automatic collection](https://stripe.com/docs/invoicing/automatic-charging) + of the invoice. When `false`, the invoice's state will not 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. + "/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. + "/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. + "/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 + 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: + 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. + maxLength: 5000 + type: string + 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. + "/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.
+ +Requests made in test-mode result in no emails being sent, despite sending an invoice.sent event.
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.
+ 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. + "/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.
Retrieves an Issuing Authorization object.
Updates the specified Issuing Authorization object
+ by setting the values of the parameters passed. Any parameters not provided
+ will be left unchanged.
Approves a pending Issuing Authorization object.
+ This request should be made within the timeout window of the real-time
+ authorization flow. \nYou can also respond directly to the webhook request
+ to approve an authorization (preferred). More details can be found here.
Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow.
+ You can also respond directly to the webhook request to decline an authorization (preferred). More details can be found here.
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.
Creates a new Issuing Cardholder object that can
+ be issued cards.
Retrieves an Issuing Cardholder object.
Updates the specified Issuing Cardholder object
+ by setting the values of the parameters passed. Any parameters not provided
+ will be left unchanged.
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.
Creates an Issuing Card object.
Retrieves an Issuing Card object.
Updates the specified Issuing Card object by setting
+ the values of the parameters passed. Any parameters not provided will be left
+ unchanged.
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.
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.
Retrieves an Issuing Dispute object.
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.
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.
Returns a list of Issuing Settlement objects.
+ The objects are sorted in descending order by creation date, with the most
+ recently created object appearing first.
Retrieves an Issuing Settlement object.
Updates the specified Issuing Settlement object
+ by setting the values of the parameters passed. Any parameters not provided
+ will be left unchanged.
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.
Retrieves an Issuing Transaction object.
Updates the specified Issuing Transaction object
+ by setting the values of the parameters passed. Any parameters not provided
+ will be left unchanged.
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.
Retrieves the details of a Financial Connections Session
Returns a list of Financial Connections Account
+ objects.
Retrieves the details of an Financial Connections Account.
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).
Lists all owners for a given Account
Refreshes the data associated with a Financial Connections
+ Account.
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. + "/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 + description: Successful response. + default: + content: + application/json: + schema: + "$ref": "#/components/schemas/error" + description: Error response. + post: + description: "Creates a new open order object.
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. + 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 + client_permissions: + 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: + type: boolean + required: + - enabled + title: automatic_tax + type: object + billing_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: validated_optional_fields_address + type: object + email: + type: string + name: + maxLength: 5000 + type: string + phone: + maxLength: 20 + type: string + title: billing_details + type: object + - 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. + client_permissions: + description: The fields on the order that are allowed to be updated + from your frontend application with a publishable key and order + client secret. + properties: + billing_details: + enum: + - allow + - disallow + type: string + promotion_codes: + enum: + - allow + - disallow + type: string + shipping_details: + enum: + - allow + - disallow + type: string + title: client_permissions + 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). + 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: + 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, 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: + maxLength: 5000 + type: string + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + 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: + 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 + title: price_data_with_optional_product + type: object + product: + maxLength: 5000 + type: string + product_data: + properties: + description: + maxLength: 40000 + type: string + id: + maxLength: 5000 + type: string + images: + anyOf: + - items: + type: string + type: array + - enum: + - '' + type: string + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - enum: + - '' + type: string + name: + 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 + shippable: + type: boolean + tax_code: + maxLength: 5000 + type: string + url: + anyOf: + - type: string + - enum: + - '' + type: string + required: + - id + - name + title: product_upsert_data + type: object + quantity: + type: integer + tax_rates: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + title: 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`. + payment: + description: Payment information associated with the order, including + payment settings. + properties: + settings: + properties: + application_fee_amount: + anyOf: + - type: integer + - enum: + - '' + type: string + payment_method_options: + 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 + verification_method: + enum: + - automatic + - instant + - microdeposits + type: string + x-stripeBypassValidation: true + title: payment_intent_payment_method_options_param + type: object + - enum: + - '' + type: string + afterpay_clearpay: + anyOf: + - properties: + capture_method: + enum: + - automatic + - manual + type: string + reference: + maxLength: 128 + type: string + setup_future_usage: + enum: + - none + type: string + title: afterpay_clearpay_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 + 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 + card: + anyOf: + - properties: + capture_method: + enum: + - automatic + - manual + type: string + setup_future_usage: + enum: + - none + - off_session + - on_session + type: string + title: card_payment_method_options + 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: + - iban + - sepa + - 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 + 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 + ideal: + anyOf: + - properties: + 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 + preferred_locale: + enum: + - da-DK + - de-AT + - de-CH + - de-DE + - en-AT + - en-AU + - en-BE + - en-CA + - en-CH + - en-DE + - en-DK + - en-ES + - en-FI + - en-FR + - en-GB + - en-IE + - en-IT + - en-NL + - en-NO + - en-NZ + - en-PL + - en-PT + - 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 + - sv-FI + - sv-SE + type: string + x-stripeBypassValidation: true + setup_future_usage: + enum: + - none + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string + link: + anyOf: + - properties: + capture_method: + enum: + - '' + - manual + type: string + persistent_token: + maxLength: 5000 + type: string + setup_future_usage: + enum: + - '' + - none + - off_session + 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 + sepa_debit: + anyOf: + - properties: + mandate_options: + properties: {} + title: payment_method_options_mandate_options_param + type: object + setup_future_usage: + enum: + - '' + - none + - off_session + - on_session + 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 + 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 + required: + - client + title: payment_method_options_param + type: object + - enum: + - '' + type: string + title: update_params + type: object + payment_method_types: + 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 + - sepa_debit + - sofort + - wechat_pay + type: string + x-stripeBypassValidation: true + type: array + return_url: + anyOf: + - type: string + - enum: + - '' + type: string + statement_descriptor: + maxLength: 22 + type: string + statement_descriptor_suffix: + maxLength: 22 + type: string + transfer_data: + anyOf: + - properties: + amount: + type: integer + destination: + type: string + required: + - destination + title: transfer_data + type: object + - enum: + - '' + type: string + title: update_params + type: object + required: + - settings + title: update_params + 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: + 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 customer cost of shipping for this + order. + 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: validated_optional_fields_address + type: object + name: + maxLength: 5000 + type: string + phone: + maxLength: 5000 + type: string + required: + - address + - name + title: shipping_details + type: object + - 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: + enum: + - '' + - exempt + - none + - reverse + type: string + tax_ids: + items: + properties: + type: + enum: + - ae_trn + - au_abn + - au_arn + - bg_uic + - br_cnpj + - br_cpf + - ca_bn + - ca_gst_hst + - ca_pst_bc + - ca_pst_mb + - ca_pst_sk + - ca_qst + - ch_vat + - cl_tin + - eg_tin + - es_cif + - eu_oss_vat + - eu_vat + - gb_vat + - ge_vat + - hk_br + - hu_tin + - id_npwp + - il_vat + - in_gst + - is_vat + - jp_cn + - jp_rn + - jp_trn + - ke_pin + - kr_brn + - li_uid + - mx_rfc + - my_frp + - my_itn + - my_sst + - no_vat + - nz_gst + - ph_tin + - ru_inn + - ru_kpp + - sa_vat + - sg_gst + - sg_uen + - si_tin + - th_vat + - tr_tin + - tw_vat + - ua_vat + - us_ein + - za_vat + maxLength: 5000 + type: string + x-stripeBypassValidation: true + value: + type: string + required: + - type + - value + title: data_params + type: object + type: array + title: tax_details + type: object + 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. + "/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. + "/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 + description: Successful response. + default: + content: + application/json: + schema: + "$ref": "#/components/schemas/error" + description: Error response. + "/v1/orders/{id}/reopen": + post: + description: "Reopens a submitted order.
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.
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 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 PaymentIntents 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: 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. + post: + description: |- +Creates a PaymentIntent object.
+ +After the PaymentIntent is created, attach a payment method and confirm + to continue the payment. You can read more about the different payment flows + available via the Payment Intents API here.
+ +When confirm=true is used during creation, it is equivalent to creating
+ and confirming the PaymentIntent in the same call. You may use any parameters
+ available in the confirm API when confirm=true
+ is supplied.
Search for PaymentIntents you’ve previously created using Stripe’s Search Query Language. + Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating + conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up + to 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. + "/v1/payment_intents/{intent}": + get: + description: |- +Retrieves the details of a PaymentIntent that has previously been created.
+ +Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string.
When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the payment intent object reference for more details.
+ operationId: GetPaymentIntentsIntent + parameters: + - description: The client secret of the PaymentIntent. 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: 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. + post: + description: |- +Updates properties on a PaymentIntent object without confirming.
+ +Depending on which properties you update, you may need to confirm the
+ PaymentIntent again. For example, updating the payment_method will
+ always require you to confirm the PaymentIntent again. If you prefer to
+ update and confirm at the same time, we recommend updating properties via
+ the confirm API instead.
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 intended to be applied to this PaymentIntent from the customer’s cash balance. + + 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 maximum amount is the amount of the PaymentIntent. + + When omitted, the amount 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). + 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. + "/v1/payment_intents/{intent}/cancel": + post: + description: |- +A PaymentIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action, or processing.
Once canceled, no additional charges will be made by the PaymentIntent and any operations on the PaymentIntent will fail with an error. For PaymentIntents with status=’requires_capture’, the remaining amount_capturable will automatically be refunded.
You cannot 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. + "/v1/payment_intents/{intent}/capture": + post: + description: |- +Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.
Uncaptured PaymentIntents will be canceled a set number of days after they are created (7 by default).
+ +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 + 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. Any additional + amount will be automatically refunded. Defaults to the full `amount_capturable` + if 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 payment amount. 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 + 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: |- + The parameters used to automatically create a Transfer when the payment + is captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). + properties: + amount: + type: integer + title: transfer_data_update_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. + "/v1/payment_intents/{intent}/confirm": + post: + description: |- +Confirm that your customer intends to pay with current or provided
+ payment method. Upon confirmation, the PaymentIntent will attempt to initiate
+ a payment.
+ If the selected payment method requires additional authentication steps, the
+ PaymentIntent will transition to the requires_action status and
+ suggest additional actions via next_action. If payment fails,
+ the PaymentIntent will transition to the requires_payment_method status. If
+ payment succeeds, the PaymentIntent will transition to the succeeded
+ status (or requires_capture, if capture_method is set to manual).
+ If the confirmation_method is automatic, payment may be attempted
+ using our client SDKs
+ and the PaymentIntent’s client_secret.
+ After next_actions are handled by the client, no additional
+ confirmation is required to complete the payment.
+ If the confirmation_method is manual, all payment attempts must be
+ initiated using a secret key.
+ If any actions are required for the payment, the PaymentIntent will
+ return to the requires_confirmation state
+ after those actions are completed. Your server needs to then
+ explicitly re-confirm the PaymentIntent to initiate the next payment
+ attempt. Read the expanded documentation
+ to learn more about manual confirmation.
Perform an incremental authorization on an eligible
+ PaymentIntent. To be eligible, the
+ PaymentIntent’s status must be requires_capture and
+ incremental_authorization_supported
+ must be true.
Incremental authorizations attempt to increase the authorized amount on
+ your customer’s card to the new, higher amount provided. As with the
+ initial authorization, incremental authorizations may be declined. A
+ single PaymentIntent can call this endpoint multiple times to further
+ increase the authorized amount.
If the incremental authorization succeeds, the PaymentIntent object is + returned with the updated + amount. + If the incremental authorization fails, a + card_declined error is returned, and no + fields on the PaymentIntent or Charge are updated. The PaymentIntent + object remains capturable for the previously authorized amount.
+ +Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines. + Once captured, a PaymentIntent can no longer be incremented.
+ +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 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 payment amount. 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: 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 + transfer_data: + description: |- + The parameters used to automatically create a Transfer when the payment is captured. + For more information, see the PaymentIntents [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. + "/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. + "/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. + 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 + expand: + 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 + 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: + maxLength: 2048 + 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 subtotal 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 + required: + - enabled + title: automatic_tax_params + type: object + billing_address_collection: + description: Configuration for collecting the customer's billing + address. + enum: + - auto + - required + type: string + consent_collection: + description: Configure fields to gather active consent from customers. + properties: + 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. + type: string + 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 + 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 + quantity: + type: integer + required: + - price + - 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 + 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 + - manual + type: string + setup_future_usage: + enum: + - off_session + - on_session + 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. + + Can only be set in `subscription` mode. + + If 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 + - au_becs_debit + - bacs_debit + - bancontact + - blik + - boleto + - card + - eps + - fpx + - giropay + - grabpay + - ideal + - klarna + - konbini + - oxxo + - p24 + - paynow + - pix + - promptpay + - sepa_debit + - sofort + - us_bank_account + - wechat_pay + type: string + x-stripeBypassValidation: true + type: array + phone_number_collection: + description: |- + Controls phone number collection settings during checkout. + + We 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 + 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 + - 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 + 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 + trial_period_days: + type: integer + title: subscription_data_params + type: object + tax_id_collection: + description: Controls tax ID collection during checkout. + properties: + enabled: + type: boolean + 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. + "/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. + 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 + expand: + explode: true + style: deepObject + line_items: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + payment_method_types: + explode: true + style: deepObject + shipping_address_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: + maxLength: 2048 + 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 + required: + - enabled + title: automatic_tax_params + type: object + billing_address_collection: + description: Configuration for collecting the customer's billing + address. + enum: + - auto + - required + type: string + 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 + 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_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. + + Can only be set in `subscription` mode. + + If 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 + - au_becs_debit + - bacs_debit + - bancontact + - blik + - boleto + - card + - eps + - fpx + - giropay + - grabpay + - ideal + - klarna + - konbini + - oxxo + - p24 + - paynow + - pix + - promptpay + - sepa_debit + - sofort + - us_bank_account + - wechat_pay + 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 automatic payment methods + that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). + 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 + - 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. + 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. + "/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. + "/v1/payment_methods": + get: + description:Returns a list of PaymentMethods attached to the StripeAccount. + For listing a customer’s payment methods, you should use List + a Customer’s PaymentMethods
+ 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: + type: string + style: form + - description: Specifies which fields in 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: A required filter on the list, based on the object `type` field. + in: query + name: type + required: true + schema: + enum: + - acss_debit + - affirm + - afterpay_clearpay + - alipay + - au_becs_debit + - bacs_debit + - bancontact + - blik + - boleto + - card + - customer_balance + - eps + - fpx + - giropay + - grabpay + - ideal + - klarna + - konbini + - link + - oxxo + - p24 + - paynow + - pix + - promptpay + - sepa_debit + - sofort + - us_bank_account + - wechat_pay + 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. + post: + description: |- +Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.
+ +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 + au_becs_debit: + explode: true + style: deepObject + bacs_debit: + explode: true + style: deepObject + bancontact: + 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 + 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 + klarna: + explode: true + style: deepObject + konbini: + explode: true + style: deepObject + link: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + oxxo: + explode: true + style: deepObject + p24: + explode: true + style: deepObject + paynow: + explode: true + style: deepObject + pix: + explode: true + style: deepObject + promptpay: + explode: true + style: deepObject + radar_options: + explode: true + style: deepObject + sepa_debit: + explode: true + style: deepObject + sofort: + explode: true + style: deepObject + us_bank_account: + explode: true + style: deepObject + wechat_pay: + 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 + 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 + 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: + maxLength: 5000 + type: string + phone: + 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 + 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 + 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 + - handelsbanken + - ing + - knab + - moneyou + - rabobank + - regiobank + - revolut + - sns_bank + - triodos_bank + - van_lanschot + 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 + 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 + 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 + 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 + - volkswagen_bank + type: string + x-stripeBypassValidation: true + 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 + 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 + 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 + 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 + - au_becs_debit + - bacs_debit + - bancontact + - blik + - boleto + - card + - customer_balance + - eps + - fpx + - giropay + - grabpay + - ideal + - klarna + - konbini + - link + - oxxo + - p24 + - paynow + - pix + - promptpay + - sepa_debit + - sofort + - us_bank_account + - wechat_pay + 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 + 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. + "/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. + post: + description: "Updates a PaymentMethod object. A PaymentMethod must be attached + 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 + us_bank_account: + explode: true + style: deepObject + schema: + additionalProperties: false + 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: + 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: + maxLength: 5000 + type: string + phone: + 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 + 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`. + 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 + 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. + "/v1/payment_methods/{payment_method}/attach": + post: + description: |- +Attaches a PaymentMethod object to a Customer.
+ +To attach a new PaymentMethod to a customer for future payments, we recommend you use a SetupIntent
+ or a PaymentIntent with setup_future_usage.
+ These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach
+ endpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for
+ future use, which makes later declines and payment friction more likely.
+ See Optimizing cards for future payments for more information about setting up
+ future payments.
To use this PaymentMethod as the default for invoice or subscription payments,
+ set invoice_settings.default_payment_method,
+ on the Customer to the PaymentMethod’s ID.
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. + "/v1/payouts": + get: + description: "Returns a list of existing payouts sent to third-party bank + accounts or that Stripe has sent you. The payouts are returned in sorted order, + with the most recently created payouts appearing first.
" + operationId: GetPayouts + parameters: + - 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 + - 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. + post: + description: |- +To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.
+ +If your API key is in test mode, money won’t actually be sent, though everything else will occur as if in live mode.
+ +If you are creating a manual payout on a Stripe account that uses multiple payment source types, you’ll need to specify the source type balance that the payout should draw 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). + 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 no destination is supplied, the default external account + for the specified currency will be used. + 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 can be `standard` + or `instant`. `instant` is only supported for payouts to debit + cards. (See [Instant payouts for marketplaces for more information](https://stripe.com/blog/instant-payouts-for-marketplaces).) + enum: + - instant + - standard + maxLength: 5000 + type: string + x-stripeBypassValidation: true + 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 to be displayed on the recipient''s bank + or card statement. This may be at most 22 characters. Attempting + to use a `statement_descriptor` longer than 22 characters will + return an error. Note: Most banks will truncate this information + and/or display it inconsistently. Some may 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. + "/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, and Stripe + will return 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. + post: + description: "Updates the specified payout by setting the values of the parameters + passed. Any parameters not provided will be left unchanged. This request accepts + only 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. + "/v1/payouts/{payout}/cancel": + post: + description: "A previously created payout can be canceled if it has not yet + been paid out. Funds will be refunded to your available balance. You may not + 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. + "/v1/payouts/{payout}/reverse": + post: + description: |- +Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts may be reversed at this time. If the payout is in the pending status, /v1/payouts/:id/cancel should be used instead.
By requesting a reversal via /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account has authorized the debit on the bank account and that no other authorization is required.
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. + 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 + aggregate_usage: + description: Specifies a usage aggregation strategy for plans of + `usage_type=metered`. Allowed values are `sum` for summing up + all usage during a period, `last_during_period` for using the + last usage record reported within a period, `last_ever` for using + the last usage record ever (across period bounds) or `max` which + uses the usage record with the maximum reported usage during a + period. Defaults to `sum`. + enum: + - last_during_period + - last_ever + - max + - sum + type: string + 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). + 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 one year interval allowed (1 year, 12 months, + or 52 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`. + 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: + 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. + "/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. + 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. + 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. + "/v1/prices": + get: + description: "Returns a list of your prices.
" + 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: + 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. + 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 + 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. + 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). + 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 that this price 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: + 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: + aggregate_usage: + enum: + - last_during_period + - last_ever + - max + - sum + type: string + interval: + enum: + - day + - month + - week + - year + type: string + interval_count: + type: integer + usage_type: + enum: + - licensed + - metered + type: string + required: + - interval + title: recurring + type: object + tax_behavior: + description: 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` + 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. + "/v1/prices/search": + get: + description: |- +Search for prices you’ve previously created using Stripe’s Search Query Language. + Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating + conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up + to 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. + "/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. + 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: 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. + "/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. + 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 + 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: + 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 + 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 + 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 + 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. + + This 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. + It must contain at least one letter. + 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 in Stripe + and on customers’ receipts and invoices. When set, this will be + included in associated invoice line item descriptions. + 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. + "/v1/products/search": + get: + description: |- +Search for products you’ve previously created using Stripe’s Search Query Language. + Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating + conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up + to 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. + "/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.
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. + 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: + expand: + explode: true + style: deepObject + images: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + package_dimensions: + explode: true + style: deepObject + tax_code: + 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: + 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 + 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: + 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. + + This 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. + It must contain at least one letter. May only be set if `type=service`. + 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: + description: A label that represents units of this product in Stripe + and on customers’ receipts and invoices. When set, this will be + included in associated invoice line item descriptions. May only + be set if `type=service`. + maxLength: 12 + type: string + 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. + "/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. + 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. If 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: + 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. + "/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.
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. + "/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 + 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. + 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.
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. + 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 + discounts: + explode: true + style: deepObject + expand: + 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 subtotal 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 + 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: + description: A description that will be displayed on the quote PDF. + maxLength: 500 + type: string + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string + description: The discounts applied to the quote. You can only set + up to one discount. + 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: + description: A footer that will be displayed on the quote PDF. + maxLength: 500 + type: string + header: + description: A header that will be displayed on the quote PDF. + maxLength: 50 + type: string + invoice_settings: + description: All invoices will be billed using the specified settings. + properties: + days_until_due: + type: integer + 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: + id: + maxLength: 5000 + type: string + price: + maxLength: 5000 + type: string + price_data: + properties: + 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: + maxLength: 500 + type: string + effective_date: + anyOf: + - enum: + - current_period_end + maxLength: 5000 + type: string + - format: unix-time + type: integer + - enum: + - '' + type: string + 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. + "/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. + "/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. + "/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. + "/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. + "/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. + "/v1/quotes/{quote}/pdf": + get: + description: "Download the PDF for a finalized quote
" + 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. + "/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: 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. + "/v1/radar/early_fraud_warnings/{early_fraud_warning}": + get: + description: |- +Retrieves the details of an early fraud warning that has previously been created.
+ +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. + "/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.
Creates a new ValueListItem object, which is added
+ to the specified parent value list.
Deletes a ValueListItem object, removing it from
+ its parent value list.
Retrieves a ValueListItem object.
Returns a list of ValueList objects. The objects
+ are sorted in descending order by creation date, with the most recently created
+ object appearing first.
Creates a new ValueList object, which can then
+ be referenced in rules.
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.
Retrieves a ValueList object.
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.
Returns a list of all refunds you’ve previously created. The + refunds are returned in sorted order, with the most recent refunds appearing + first. For convenience, 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 + - 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. + post: + description: "Create a refund.
" + 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: + description: A positive integer representing how much to refund. + type: integer + charge: + 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). + 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: Address to send refund email, use customer email if + not specified + 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: + maxLength: 5000 + type: string + reason: + enum: + - duplicate + - fraudulent + - requested_by_customer + maxLength: 5000 + type: string + refund_application_fee: + type: boolean + reverse_transfer: + 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. + "/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. + post: + description: |- +Updates the specified refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+ +This request only accepts metadata as an argument.
Cancels a refund with a status of requires_action.
Refunds in other states cannot be canceled, and only refunds for payment methods that require customer action will enter the requires_action state.
Returns a list of Report Runs, with the most recent appearing + first.
" + operationId: GetReportingReportRuns + parameters: + - 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. + 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: + 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 + - 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 + 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/Coral_Harbour + - America/Cordoba + - America/Costa_Rica + - 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. + "/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. + "/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. + "/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. + "/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.
Retrieves a Review object.
Approves a Review object, closing it and removing
+ it from the list of reviews.
Returns a list of SetupAttempts associated with a provided + SetupIntent.
" + operationId: GetSetupAttempts + 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: |- + Only return SetupAttempts created by the SetupIntent specified by + this 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. + "/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. + + It 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 associated 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. + post: + description: |- +Creates a SetupIntent object.
+ +After the SetupIntent is created, attach a payment method and confirm + to collect any required permissions to charge the payment method later.
+ operationId: PostSetupIntents + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + 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. + + It 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 + confirm: + description: Set to `true` to attempt to confirm this SetupIntent + immediately. This parameter defaults to `false`. If the payment + method attached is a card, a return_url may be provided in case + additional authentication is required. + type: boolean + customer: + description: |- + ID of the Customer this SetupIntent belongs to, if one exists. + + If 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. + + Include `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: + 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). + 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 + 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 this SetupIntent is + created. + 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_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) + value 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 + 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 + 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: + maxLength: 5000 + type: string + phone: + 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 + 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 + - handelsbanken + - ing + - knab + - moneyou + - rabobank + - regiobank + - revolut + - sns_bank + - triodos_bank + - van_lanschot + maxLength: 5000 + type: string + title: param + type: object + interac_present: + 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 + link: + properties: {} + title: param + type: object + metadata: + additionalProperties: + type: string + 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 + - volkswagen_bank + type: string + x-stripeBypassValidation: true + title: param + type: object + paynow: + 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 + 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 + type: + enum: + - acss_debit + - affirm + - afterpay_clearpay + - alipay + - au_becs_debit + - bacs_debit + - bancontact + - blik + - boleto + - customer_balance + - eps + - fpx + - giropay + - grabpay + - ideal + - klarna + - konbini + - link + - oxxo + - p24 + - paynow + - pix + - promptpay + - sepa_debit + - sofort + - us_bank_account + - wechat_pay + 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 + 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 + blik: + properties: + code: + maxLength: 5000 + type: string + 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: + 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 + - interac + - jcb + - mastercard + - unionpay + - unknown + - visa + maxLength: 5000 + type: string + x-stripeBypassValidation: true + request_three_d_secure: + enum: + - any + - automatic + maxLength: 5000 + type: string + x-stripeBypassValidation: true + title: setup_intent_param + type: object + link: + properties: + persistent_token: + maxLength: 5000 + type: string + title: setup_intent_payment_method_options_param + type: object + sepa_debit: + properties: + mandate_options: + properties: {} + 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: + permissions: + items: + enum: + - balances + - ownership + - payment_method + - transactions + maxLength: 5000 + type: string + x-stripeBypassValidation: true + type: array + return_url: + maxLength: 5000 + type: string + title: linked_account_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 (e.g. card) that this + SetupIntent is allowed to use. If this is not provided, defaults + to ["card"]. + 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. 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/setup_intents/create#create_setup_intent-confirm). + type: string + single_use: + description: If this hash is populated, this SetupIntent will generate + a single_use Mandate on success. + properties: + amount: + type: integer + 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 + 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. + "/v1/setup_intents/{intent}": + get: + description: |- +Retrieves the details of a SetupIntent that has previously been created.
+ +Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string.
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. Required if a publishable + key is used 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. + 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. + + It 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. + + If 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. + + Include `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. + 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) + value 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 + 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 + 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: + maxLength: 5000 + type: string + phone: + 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 + 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 + - handelsbanken + - ing + - knab + - moneyou + - rabobank + - regiobank + - revolut + - sns_bank + - triodos_bank + - van_lanschot + maxLength: 5000 + type: string + title: param + type: object + interac_present: + 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 + link: + properties: {} + title: param + type: object + metadata: + additionalProperties: + type: string + 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 + - volkswagen_bank + type: string + x-stripeBypassValidation: true + title: param + type: object + paynow: + 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 + 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 + type: + enum: + - acss_debit + - affirm + - afterpay_clearpay + - alipay + - au_becs_debit + - bacs_debit + - bancontact + - blik + - boleto + - customer_balance + - eps + - fpx + - giropay + - grabpay + - ideal + - klarna + - konbini + - link + - oxxo + - p24 + - paynow + - pix + - promptpay + - sepa_debit + - sofort + - us_bank_account + - wechat_pay + 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 + 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 + blik: + properties: + code: + maxLength: 5000 + type: string + 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: + 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 + - interac + - jcb + - mastercard + - unionpay + - unknown + - visa + maxLength: 5000 + type: string + x-stripeBypassValidation: true + request_three_d_secure: + enum: + - any + - automatic + maxLength: 5000 + type: string + x-stripeBypassValidation: true + title: setup_intent_param + type: object + link: + properties: + persistent_token: + maxLength: 5000 + type: string + title: setup_intent_payment_method_options_param + type: object + sepa_debit: + properties: + mandate_options: + properties: {} + 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: + permissions: + items: + enum: + - balances + - ownership + - payment_method + - transactions + maxLength: 5000 + type: string + x-stripeBypassValidation: true + type: array + return_url: + maxLength: 5000 + type: string + title: linked_account_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 (e.g. card) that this + SetupIntent is allowed to set up. If this is not provided, defaults + to ["card"]. + 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. + "/v1/setup_intents/{intent}/cancel": + post: + description: |- +A SetupIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.
Once canceled, setup is abandoned and any operations on the SetupIntent will fail with an error.
+ 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. + "/v1/setup_intents/{intent}/confirm": + post: + description: |- +Confirm that your customer intends to set up the current or + provided payment method. For example, you would confirm a SetupIntent + when a customer hits the “Save” button on a payment method management + page on your website.
+ +If the selected payment method does not require any additional
+ steps from the customer, the SetupIntent will transition to the
+ succeeded status.
Otherwise, it will transition to the requires_action status and
+ suggest additional actions via next_action. If setup fails,
+ the SetupIntent will transition to the
+ requires_payment_method status.
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. + "/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: + 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. + 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: + 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. + Can only be `fixed_amount` for now. + 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. + "/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. + 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. + "/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. + "/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. + "/v1/skus": + get: + description: "Returns a list of your SKUs. The SKUs are returned sorted by + creation date, with the most recently created SKUs appearing first.
" + operationId: GetSkus + parameters: + - description: Only return SKUs 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 SKUs that have the specified key-value pairs in this + partially constructed dictionary. Can be specified only if `product` is + also supplied. For instance, if the associated product has attributes `["color", + "size"]`, passing in `attributes[color]=red` returns all the SKUs for this + product that have `color` set to `red`. + explode: true + in: query + name: attributes + required: false + schema: + additionalProperties: + maxLength: 500 + type: string + 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: Only return SKUs with the given IDs. + explode: true + in: query + name: ids + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: Only return SKUs that are either in stock or out of stock (e.g., + pass `false` to list all SKUs that are out of stock). If no value is provided, + all SKUs are returned. + in: query + name: in_stock + 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: The ID of the product whose SKUs will be retrieved. Must be a + product with type `good`. + 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: + items: + "$ref": "#/components/schemas/sku" + type: array + has_more: + description: True if this list has another page of items after + this one that can be fetched. + type: boolean + object: + description: String representing the object's type. Objects of + the same type share 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/skus" + type: string + required: + - data + - has_more + - object + - url + title: ProductsMethodSKUList + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + "$ref": "#/components/schemas/error" + description: Error response. + post: + description: "Creates a new SKU associated with a product.
" + operationId: PostSkus + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + attributes: + explode: true + style: deepObject + expand: + explode: true + style: deepObject + inventory: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + package_dimensions: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + active: + description: Whether the SKU is available for purchase. Default + to `true`. + type: boolean + attributes: + additionalProperties: + maxLength: 500 + type: string + description: 'A dictionary of attributes and values for the attributes + defined by the product. If, for example, a product''s attributes + are `["size", "gender"]`, a valid SKU has the following dictionary + of attributes: `{"size": "Medium", "gender": "Unisex"}`.' + 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). + type: string + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + id: + description: The identifier for the SKU. Must be unique. If not + provided, an identifier will be randomly generated. + type: string + image: + description: The URL of an image for this SKU, meant to be displayable + to the customer. + maxLength: 5000 + type: string + inventory: + description: Description of the SKU's inventory. + properties: + quantity: + type: integer + type: + enum: + - bucket + - finite + - infinite + type: string + value: + enum: + - '' + - in_stock + - limited + - out_of_stock + type: string + required: + - type + title: inventory_create_specs + 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 + package_dimensions: + description: The dimensions of this SKU 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 + price: + description: The cost of the item as a nonnegative integer in the + smallest currency unit (that is, 100 cents to charge $1.00, or + 100 to charge ¥100, Japanese Yen being a zero-decimal currency). + type: integer + product: + description: The ID of the product this SKU is associated with. + Must be a product with type `good`. + maxLength: 5000 + type: string + required: + - currency + - inventory + - price + - product + type: object + required: true + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/sku" + description: Successful response. + default: + content: + application/json: + schema: + "$ref": "#/components/schemas/error" + description: Error response. + "/v1/skus/{id}": + delete: + description: "Delete a SKU. Deleting a SKU is only possible until it has + been used in an order.
" + operationId: DeleteSkusId + 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_sku" + description: Successful response. + default: + content: + application/json: + schema: + "$ref": "#/components/schemas/error" + description: Error response. + get: + description: "Retrieves the details of an existing SKU. Supply the unique + SKU identifier from either a SKU creation request or from the product, and + Stripe will return the corresponding SKU information.
" + operationId: GetSkusId + 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: + anyOf: + - "$ref": "#/components/schemas/sku" + - "$ref": "#/components/schemas/deleted_sku" + description: Successful response. + default: + content: + application/json: + schema: + "$ref": "#/components/schemas/error" + description: Error response. + post: + description: |- +Updates the specific SKU by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+ +Note that a SKU’s attributes are not editable. Instead, you would need to deactivate the existing SKU and create a new one with the new attribute values.
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. + 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: + 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: + 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. + "/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. + post: + description: |- +Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+ +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.
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. + "/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. + "/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. + 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 + 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. When updating, + pass an empty string to remove previously-defined thresholds. + 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. + + Use `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. + + Use `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). + + Use `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://stripe.com/docs/upgrades#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: + 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/subscriptions/billing-cycle#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. + 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. + "/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/subscriptions/billing-cycle#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. + 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. + 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. + 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 + 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. When updating, + pass an empty string to remove previously-defined thresholds. + 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. + 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. + + Use `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. + + Use `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). + + Use `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://stripe.com/docs/upgrades#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. 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. + properties: + 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/subscriptions/billing-cycle#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. + 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. + "/v1/subscription_items/{subscription_item}/usage_record_summaries": + get: + description: |- +For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).
+ +The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn’t ended yet. Since new usage records can still be added, the returned summary information for the subscription item’s ID should be seen as unstable until the subscription billing period ends.
+ operationId: GetSubscriptionItemsSubscriptionItemUsageRecordSummaries + 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: path + name: subscription_item + 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: + description: '' + properties: + data: + items: + "$ref": "#/components/schemas/usage_record_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 + type: string + required: + - data + - has_more + - object + - url + title: UsageEventsResourceUsageRecordSummaryList + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + "$ref": "#/components/schemas/error" + description: Error response. + "/v1/subscription_items/{subscription_item}/usage_records": + post: + description: |- +Creates a usage record for a specified subscription item and date, and fills it with a quantity.
+ +Usage records provide quantity information that Stripe uses to track how much a customer is using your service. With usage information and the pricing model set up by the metered billing plan, Stripe helps you send accurate invoices to your customers.
The default calculation for usage is to add up all the quantity values of the usage records within a billing period. You can change this default behavior with the billing plan’s aggregate_usage parameter. When there is more than one usage record with the same timestamp, Stripe adds the quantity values together. In most cases, this is the desired resolution, however, you can change this behavior with the action parameter.
The default pricing model for metered billing is per-unit pricing. For finer granularity, you can configure metered billing to have a tiered pricing model.
+ operationId: PostSubscriptionItemsSubscriptionItemUsageRecords + parameters: + - in: path + name: subscription_item + required: true + schema: + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + timestamp: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + action: + description: Valid values are `increment` (default) or `set`. When + using `increment` the specified `quantity` will be added to the + usage at the specified timestamp. The `set` action will overwrite + the usage quantity at that timestamp. If the subscription has + [billing thresholds](https://stripe.com/docs/api/subscriptions/object#subscription_object-billing_thresholds), + `increment` is the only allowed value. + enum: + - increment + - set + type: string + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + quantity: + description: The usage quantity for the specified timestamp. + type: integer + timestamp: + anyOf: + - enum: + - now + maxLength: 5000 + type: string + - type: integer + description: The timestamp for the usage event. This timestamp must + be within the current billing period of the subscription of the + provided `subscription_item`, and must not be in the future. When + passing `"now"`, Stripe records usage for the current time. Default + is `"now"` if a value is not provided. + required: + - quantity + type: object + required: true + responses: + '200': + content: + application/json: + schema: + "$ref": "#/components/schemas/usage_record" + description: Successful response. + default: + content: + application/json: + schema: + "$ref": "#/components/schemas/error" + description: Error response. + "/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. + 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: + 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: + 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 + 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: + maxLength: 500 + type: string + invoice_settings: + properties: + days_until_due: + type: integer + title: subscription_schedules_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: Configures how the subscription schedule behaves 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: + price: + maxLength: 5000 + type: string + price_data: + properties: + 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_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 + 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 + coupon: + maxLength: 5000 + type: string + 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: + maxLength: 500 + type: string + end_date: + format: unix-time + type: integer + invoice_settings: + properties: + days_until_due: + type: integer + title: subscription_schedules_param + 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 + price: + maxLength: 5000 + type: string + price_data: + properties: + 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: + - 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. + "/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. + 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 + 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: + maxLength: 500 + type: string + invoice_settings: + properties: + days_until_due: + type: integer + title: subscription_schedules_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: Configures how the subscription schedule behaves 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: + price: + maxLength: 5000 + type: string + price_data: + properties: + 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_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 + 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 + coupon: + maxLength: 5000 + type: string + default_payment_method: + maxLength: 5000 + type: string + default_tax_rates: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + description: + maxLength: 500 + type: string + end_date: + anyOf: + - type: integer + - enum: + - now + maxLength: 5000 + type: string + invoice_settings: + properties: + days_until_due: + type: integer + title: subscription_schedules_param + 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 + price: + maxLength: 5000 + type: string + price_data: + properties: + 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: + - 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: + - 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 current phase, indicates + whether the changes should be prorated. 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. + "/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.
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.
By default, returns a list of subscriptions that have not been
+ canceled. In order to list canceled subscriptions, specify status=canceled.
Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.
+ +When you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request.
+ The payment_behavior parameter determines the exact behavior of the initial payment.
To start subscriptions where the first invoice always begins in a draft status, use subscription schedules instead.
+ Schedules provide the flexibility to model more complex billing configurations that change over time.
Search for subscriptions you’ve previously created using Stripe’s Search Query Language. + Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating + conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up + to 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. + "/v1/subscriptions/{subscription_exposed_id}": + delete: + description: |- +Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.
+ +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.
+ +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: 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: + 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: Will generate a final invoice that invoices for any + un-invoiced metered usage and new/pending proration invoice items. + type: boolean + prorate: + description: 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. + 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. + 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: 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 + 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 + expand: + 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 + 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: + price: + maxLength: 5000 + type: string + price_data: + properties: + 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_rates: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + title: add_invoice_item_entry + type: object + 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 subtotal 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 subscription. We recommend + you only include this parameter when the existing value is being + changed. + properties: + enabled: + type: boolean + 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. Pass an + empty string to remove previously-defined thresholds. + cancel_at: + anyOf: + - format: unix-time + type: integer + - enum: + - '' + 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: Boolean indicating whether this subscription should + cancel at the end of the current period. + 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 + coupon: + description: The ID of the coupon to apply to this subscription. + A coupon applied to a subscription will only affect invoices created + for that particular subscription. + 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. Pass + an empty string to remove previously-defined tax rates. + 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. + maxLength: 500 + type: string + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + 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 + id: + maxLength: 5000 + type: string + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - enum: + - '' + type: string + price: + maxLength: 5000 + type: string + price_data: + properties: + 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. + 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. + 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. + + Use `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. + + Use `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). + + Use `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://stripe.com/docs/upgrades#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 + - interac + - jcb + - mastercard + - unionpay + - unknown + - visa + maxLength: 5000 + type: string + x-stripeBypassValidation: true + request_three_d_secure: + enum: + - any + - automatic + 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 + us_bank_account: + anyOf: + - properties: + financial_connections: + properties: + permissions: + items: + enum: + - balances + - ownership + - payment_method + - transactions + maxLength: 5000 + 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 + - au_becs_debit + - bacs_debit + - bancontact + - boleto + - card + - customer_balance + - fpx + - giropay + - grabpay + - ideal + - konbini + - link + - paynow + - promptpay + - sepa_debit + - sofort + - 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. + promotion_code: + description: The promotion code to apply to this subscription. A + promotion code applied to a subscription will only affect invoices + created for that particular subscription. + maxLength: 5000 + type: string + proration_behavior: + description: Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#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. + 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 exactly the same proration that was previewed with [upcoming + invoice](https://stripe.com/docs/api#retrieve_customer_invoice) + endpoint. It 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 + 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. + "/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. + "/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. + "/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. + "/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. + 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:US), + without country prefix. For example, "NY" for New York, United + States.' + maxLength: 2 + type: string + tax_type: + description: The high-level tax type, such as `vat` or `sales_tax`. + enum: + - gst + - hst + - jct + - pst + - qst + - rst + - sales_tax + - vat + type: string + 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. + "/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. + 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:US), + without country prefix. For example, "NY" for New York, United + States.' + maxLength: 2 + type: string + tax_type: + description: The high-level tax type, such as `vat` or `sales_tax`. + enum: + - gst + - hst + - jct + - pst + - qst + - rst + - sales_tax + - vat + type: string + 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. + "/v1/terminal/configurations": + get: + description: "Returns a list of Configuration objects.
Creates a new Configuration object.
Deletes a Configuration object.
Retrieves a Configuration object.
Updates a new Configuration object.
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://stripe.com/docs/terminal/fleet/locations#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. + "/v1/terminal/locations": + get: + description: "Returns a list of Location objects.
Creates a new Location object.
+ For further details, including which address fields are required in each country, see the Manage locations guide.
Deletes a Location object.
Retrieves a Location object.
Updates a Location object by setting the values
+ of the parameters passed. Any parameters not provided will be left unchanged.
Returns a list of Reader objects.
Creates a new Reader object.
Deletes a Reader object.
Retrieves a Reader object.
Updates a Reader object by setting the values
+ of the parameters passed. Any parameters not provided will be left unchanged.
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. + "/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: + 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. + "/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 + schema: + additionalProperties: false + properties: + customer_consent_collected: + description: Customer Consent Collected + type: boolean + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + setup_intent: + description: SetupIntent ID + maxLength: 5000 + type: string + required: + - customer_consent_collected + - 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. + "/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: + 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. + "/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). + 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. + "/v1/test_helpers/issuing/cards/{card}/shipping/deliver": + post: + description: "Updates the shipping status of the specified Issuing Card
+ object to delivered.
Updates the shipping status of the specified Issuing Card
+ object to failure.
Updates the shipping status of the specified Issuing Card
+ object to returned.
Updates the shipping status of the specified Issuing Card
+ object to shipped.
Expire a refund with a status of requires_action.
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_present: + explode: true + style: deepObject + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + 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 + type: + description: Simulated payment type + enum: + - card_present + type: string + x-stripeBypassValidation: true + 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. + "/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. + 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. + "/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. + 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. + "/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.
Transitions a test mode created InboundTransfer to the failed
+ status. The InboundTransfer must already be in the processing
+ state.
Marks the test mode InboundTransfer object as returned and
+ links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already
+ be in the succeeded state.
Transitions a test mode created InboundTransfer to the succeeded
+ status. The InboundTransfer must already be in the processing
+ state.
Transitions a test mode created OutboundPayment to the failed
+ status. The OutboundPayment must already be in the processing
+ state.
Transitions a test mode created OutboundPayment to the posted
+ status. The OutboundPayment must already be in the processing
+ state.
Transitions a test mode created OutboundPayment to the returned
+ status. The OutboundPayment must already be in the processing
+ state.
Transitions a test mode created OutboundTransfer to the failed
+ status. The OutboundTransfer must already be in the processing
+ state.
Transitions a test mode created OutboundTransfer to the posted
+ status. The OutboundTransfer must already be in the processing
+ state.
Transitions a test mode created OutboundTransfer to the returned
+ status. The OutboundTransfer must already be in the processing
+ state.
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). + 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: The rails used for the object. + 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. + "/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). + 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: The rails used for the object. + 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. + "/v1/tokens": + post: + description: |- +Creates a single-use token that represents a bank account’s details. + This token can be used with any API method in place of a bank account dictionary. This token can be used only once, by attaching it to a Custom account.
+ 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 will represent. + 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: 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 + executives_provided: + type: boolean + 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 + phone: + maxLength: 5000 + type: string + registration_number: + maxLength: 5000 + type: string + structure: + enum: + - '' + - free_zone_establishment + - free_zone_llc + - government_instrumentality + - governmental_unit + - incorporated_non_profit + - limited_liability_partnership + - llc + - multi_member_llc + - private_company + - private_corporation + - private_partnership + - public_company + - public_corporation + - public_partnership + - single_member_llc + - sole_establishment + - sole_proprietorship + - tax_exempt_government_instrumentality + - unincorporated_association + - unincorporated_non_profit + 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 + 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: + 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 + number: + maxLength: 5000 + type: string + required: + - exp_month + - exp_year + - number + title: credit_card_specs + type: object + - maxLength: 5000 + type: string + x-stripeBypassValidation: true + customer: + description: The customer (owned by the application's account) for + which to create a token. This can be used only with an [OAuth + access token](https://stripe.com/docs/connect/standard-accounts) + or [Stripe-Account header](https://stripe.com/docs/connect/authentication). + For more details, see [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 will represent. + 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 will represent. + 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 + documents: + properties: + company_authorization: + properties: + files: + items: + maxLength: 500 + type: string + type: array + title: documents_param + type: object + passport: + properties: + files: + items: + maxLength: 500 + type: string + type: array + title: documents_param + type: object + visa: + properties: + files: + items: + maxLength: 500 + 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: + maxLength: 5000 + 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 + representative: + type: boolean + title: + maxLength: 5000 + type: string + title: relationship_specs + type: object + ssn_last_4: + 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: person_token_specs + type: object + pii: + description: The PII this token will represent. + 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. + "/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. + "/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. + 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. + "/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. + 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. + "/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. + "/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: + - 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. + 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: 3-letter [ISO code for currency](https://stripe.com/docs/payouts). + 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/charges-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/charges-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. + "/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.
When you create a new reversal, you must specify a transfer to create it on.
+ +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.
+ +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. It is displayed alongside the reversal in the Dashboard. + 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. + "/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. + post: + description: |- +Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+ +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. + "/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. + post: + description: |- +Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+ +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. + "/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. + 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. + "/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. + "/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. + 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. + "/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. + "/v1/treasury/financial_accounts": + get: + description: "Returns a list of FinancialAccounts.
" + operationId: GetTreasuryFinancialAccounts + parameters: + - 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 + requestBody: + 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. + post: + description: "Creates a new FinancialAccount. For now, each connected account + can only have one FinancialAccount.
" + 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 + 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: 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 + 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. + "/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. + 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 + metadata: + 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: 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 + 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. + "/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. + 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: 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. + "/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 + style: 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. + 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). + 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. + "/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. + "/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. + "/v1/treasury/outbound_payments": + get: + description: "Returns a list of OutboundPayments sent from the specified + FinancialAccount.
" + operationId: GetTreasuryOutboundPayments + parameters: + - 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. + 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). + 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: + maxLength: 5000 + type: string + phone: + maxLength: 5000 + 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 + 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 `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. + "/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. + "/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. + "/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. + post: + description: "Creates an OutboundTransfer.
" + operationId: PostTreasuryOutboundTransfers + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + 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). + 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_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 `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. + "/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. + "/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. + "/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 + - payout + type: string + x-stripeBypassValidation: true + 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. + "/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. + "/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. + "/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. + "/v1/treasury/transaction_entries": + get: + description: "Retrieves a list of TransactionEntry objects.
" + operationId: GetTreasuryTransactionEntries + parameters: + - 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. + "/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. + "/v1/treasury/transactions": + get: + description: "Retrieves a list of Transaction objects.
" + operationId: GetTreasuryTransactions + parameters: + - 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. + "/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. + "/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. + 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.
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. + 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. + post: + description: "Updates the webhook endpoint. You may edit the url,
+ the list of enabled_events, and the status of your endpoint.