From 2786a29c17523cc6c00547153ca7f0123fbe0241 Mon Sep 17 00:00:00 2001 From: xsalefter Date: Sun, 7 Apr 2024 01:07:58 +0700 Subject: [PATCH 1/4] various update. See commit body 1. Update Kill Bill link from "http://kill-bill.org/" to "https://killbill.io" 2. Update axios, openapi-generator-cli, and "typescript" I tried to update test library, however it's causing test error. --- package-lock.json | 763 +++++++++++++++++++++------------------------- package.json | 10 +- 2 files changed, 353 insertions(+), 420 deletions(-) diff --git a/package-lock.json b/package-lock.json index 9bb1de6..11d28c7 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,25 +1,25 @@ { "name": "killbill", - "version": "0.23.0-beta.1", + "version": "0.24.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "killbill", - "version": "0.23.0-beta.1", + "version": "0.24.0", "license": "Apache-2.0", "dependencies": { - "axios": "^1.1.0" + "axios": "^1.6.8" }, "devDependencies": { - "@openapitools/openapi-generator-cli": "^2.5.1", + "@openapitools/openapi-generator-cli": "^2.13.1", "@types/chai": "^4.2.12", "@types/mocha": "^10.0.0", "@types/node": "^18.0.0", "chai": "^4.2.0", "mocha": "^10.0.0", "ts-node": "^10.7.0", - "typescript": "^4.0.3" + "typescript": "^5.4.4" } }, "node_modules/@cspotcode/source-map-support": { @@ -59,32 +59,48 @@ "@jridgewell/sourcemap-codec": "^1.4.10" } }, + "node_modules/@lukeed/csprng": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@lukeed/csprng/-/csprng-1.1.0.tgz", + "integrity": "sha512-Z7C/xXCiGWsg0KuKsHTKJxbWhpI3Vs5GwLfOean7MGyVFGqdRgBbAjOCh6u4bbjPc/8MJ2pZmK/0DLdCbivLDA==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/@nestjs/axios": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/@nestjs/axios/-/axios-3.0.1.tgz", + "integrity": "sha512-VlOZhAGDmOoFdsmewn8AyClAdGpKXQQaY1+3PGB+g6ceurGIdTxZgRX3VXc1T6Zs60PedWjg3A82TDOB05mrzQ==", + "dev": true, + "peerDependencies": { + "@nestjs/common": "^7.0.0 || ^8.0.0 || ^9.0.0 || ^10.0.0", + "axios": "^1.3.1", + "reflect-metadata": "^0.1.12", + "rxjs": "^6.0.0 || ^7.0.0" + } + }, "node_modules/@nestjs/common": { - "version": "8.4.4", - "resolved": "https://registry.npmjs.org/@nestjs/common/-/common-8.4.4.tgz", - "integrity": "sha512-QHi7QcgH/5Jinz+SCfIZJkFHc6Cch1YsAEGFEhi6wSp6MILb0sJMQ1CX06e9tCOAjSlBwaJj4PH0eFCVau5v9Q==", + "version": "10.3.0", + "resolved": "https://registry.npmjs.org/@nestjs/common/-/common-10.3.0.tgz", + "integrity": "sha512-DGv34UHsZBxCM3H5QGE2XE/+oLJzz5+714JQjBhjD9VccFlQs3LRxo/epso4l7nJIiNlZkPyIUC8WzfU/5RTsQ==", "dev": true, "dependencies": { - "axios": "0.26.1", "iterare": "1.2.1", - "tslib": "2.3.1", - "uuid": "8.3.2" + "tslib": "2.6.2", + "uid": "2.0.2" }, "funding": { "type": "opencollective", "url": "https://opencollective.com/nest" }, "peerDependencies": { - "cache-manager": "*", "class-transformer": "*", "class-validator": "*", "reflect-metadata": "^0.1.12", "rxjs": "^7.1.0" }, "peerDependenciesMeta": { - "cache-manager": { - "optional": true - }, "class-transformer": { "optional": true }, @@ -93,45 +109,29 @@ } } }, - "node_modules/@nestjs/common/node_modules/axios": { - "version": "0.26.1", - "resolved": "https://registry.npmjs.org/axios/-/axios-0.26.1.tgz", - "integrity": "sha512-fPwcX4EvnSHuInCMItEhAGnaSEXRBjtzh9fOtsE6E1G6p7vl7edEeZe11QHf18+6+9gR5PbKV/sGKNaD8YaMeA==", - "dev": true, - "dependencies": { - "follow-redirects": "^1.14.8" - } - }, - "node_modules/@nestjs/common/node_modules/tslib": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.3.1.tgz", - "integrity": "sha512-77EbyPPpMz+FRFRuAFlWMtmgUWGe9UOG2Z25NqCwiIjRhOf5iKGuzSe5P2w1laq+FkRy4p+PCuVkJSGkzTEKVw==", - "dev": true - }, "node_modules/@nestjs/core": { - "version": "8.4.4", - "resolved": "https://registry.npmjs.org/@nestjs/core/-/core-8.4.4.tgz", - "integrity": "sha512-Ef3yJPuzAttpNfehnGqIV5kHIL9SHptB5F4ERxoU7pT61H3xiYpZw6hSjx68cJO7cc6rm7/N+b4zeuJvFHtvBg==", + "version": "10.3.0", + "resolved": "https://registry.npmjs.org/@nestjs/core/-/core-10.3.0.tgz", + "integrity": "sha512-N06P5ncknW/Pm8bj964WvLIZn2gNhHliCBoAO1LeBvNImYkecqKcrmLbY49Fa1rmMfEM3MuBHeDys3edeuYAOA==", "dev": true, "hasInstallScript": true, "dependencies": { "@nuxtjs/opencollective": "0.3.2", "fast-safe-stringify": "2.1.1", "iterare": "1.2.1", - "object-hash": "3.0.0", "path-to-regexp": "3.2.0", - "tslib": "2.3.1", - "uuid": "8.3.2" + "tslib": "2.6.2", + "uid": "2.0.2" }, "funding": { "type": "opencollective", "url": "https://opencollective.com/nest" }, "peerDependencies": { - "@nestjs/common": "^8.0.0", - "@nestjs/microservices": "^8.0.0", - "@nestjs/platform-express": "^8.0.0", - "@nestjs/websockets": "^8.0.0", + "@nestjs/common": "^10.0.0", + "@nestjs/microservices": "^10.0.0", + "@nestjs/platform-express": "^10.0.0", + "@nestjs/websockets": "^10.0.0", "reflect-metadata": "^0.1.12", "rxjs": "^7.1.0" }, @@ -147,12 +147,6 @@ } } }, - "node_modules/@nestjs/core/node_modules/tslib": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.3.1.tgz", - "integrity": "sha512-77EbyPPpMz+FRFRuAFlWMtmgUWGe9UOG2Z25NqCwiIjRhOf5iKGuzSe5P2w1laq+FkRy4p+PCuVkJSGkzTEKVw==", - "dev": true - }, "node_modules/@nuxtjs/opencollective": { "version": "0.3.2", "resolved": "https://registry.npmjs.org/@nuxtjs/opencollective/-/opencollective-0.3.2.tgz", @@ -172,27 +166,29 @@ } }, "node_modules/@openapitools/openapi-generator-cli": { - "version": "2.5.2", - "resolved": "https://registry.npmjs.org/@openapitools/openapi-generator-cli/-/openapi-generator-cli-2.5.2.tgz", - "integrity": "sha512-FLgkjzpDiHVsH821db0VDSElDoA6TcspGyq3RD4zLBJaJhbSsRwr4u87sNoyuHKBg4OMJbZMT4iJxAhkosKrzw==", + "version": "2.13.1", + "resolved": "https://registry.npmjs.org/@openapitools/openapi-generator-cli/-/openapi-generator-cli-2.13.1.tgz", + "integrity": "sha512-WJB6MsFXlA69mpKCuR3hBsdFr7MptNhoIGlyvoYEorBQEg3cd6n1gACHx0fz20B3e03/imvorQlNMsrHTIeU9w==", "dev": true, "hasInstallScript": true, "dependencies": { - "@nestjs/common": "8.4.4", - "@nestjs/core": "8.4.4", + "@nestjs/axios": "3.0.1", + "@nestjs/common": "10.3.0", + "@nestjs/core": "10.3.0", "@nuxtjs/opencollective": "0.3.2", + "axios": "1.6.5", "chalk": "4.1.2", "commander": "8.3.0", - "compare-versions": "4.1.3", + "compare-versions": "4.1.4", "concurrently": "6.5.1", "console.table": "0.10.0", - "fs-extra": "10.0.1", - "glob": "7.1.6", - "inquirer": "8.2.2", + "fs-extra": "10.1.0", + "glob": "7.2.3", + "inquirer": "8.2.6", "lodash": "4.17.21", "reflect-metadata": "0.1.13", - "rxjs": "7.5.5", - "tslib": "2.0.3" + "rxjs": "7.8.1", + "tslib": "2.6.2" }, "bin": { "openapi-generator-cli": "main.js" @@ -205,20 +201,15 @@ "url": "https://opencollective.com/openapi_generator" } }, - "node_modules/@openapitools/openapi-generator-cli/node_modules/chalk": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", - "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "node_modules/@openapitools/openapi-generator-cli/node_modules/axios": { + "version": "1.6.5", + "resolved": "https://registry.npmjs.org/axios/-/axios-1.6.5.tgz", + "integrity": "sha512-Ii012v05KEVuUoFWmMW/UQv9aRIc3ZwkWDcM+h5Il8izZCtRVpDUfwpoFf7eOtajT3QiGR4yDUx7lPqHJULgbg==", "dev": true, "dependencies": { - "ansi-styles": "^4.1.0", - "supports-color": "^7.1.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/chalk?sponsor=1" + "follow-redirects": "^1.15.4", + "form-data": "^4.0.0", + "proxy-from-env": "^1.1.0" } }, "node_modules/@tsconfig/node10": { @@ -252,16 +243,19 @@ "dev": true }, "node_modules/@types/mocha": { - "version": "10.0.0", - "resolved": "https://registry.npmjs.org/@types/mocha/-/mocha-10.0.0.tgz", - "integrity": "sha512-rADY+HtTOA52l9VZWtgQfn4p+UDVM2eDVkMZT1I6syp0YKxW2F9v+0pbRZLsvskhQv/vMb6ZfCay81GHbz5SHg==", + "version": "10.0.6", + "resolved": "https://registry.npmjs.org/@types/mocha/-/mocha-10.0.6.tgz", + "integrity": "sha512-dJvrYWxP/UcXm36Qn36fxhUKu8A/xMRXVT2cliFF1Z7UA9liG5Psj3ezNSZw+5puH2czDXRLcXQxf8JbJt0ejg==", "dev": true }, "node_modules/@types/node": { - "version": "18.11.15", - "resolved": "https://registry.npmjs.org/@types/node/-/node-18.11.15.tgz", - "integrity": "sha512-VkhBbVo2+2oozlkdHXLrb3zjsRkpdnaU2bXmX8Wgle3PUi569eLRaHGlgETQHR7lLL1w7GiG3h9SnePhxNDecw==", - "dev": true + "version": "18.19.30", + "resolved": "https://registry.npmjs.org/@types/node/-/node-18.19.30.tgz", + "integrity": "sha512-453z1zPuJLVDbyahaa1sSD5C2sht6ZpHp5rgJNs+H8YGqhluCXcuOUmBYsAo0Tos0cHySJ3lVUGbGgLlqIkpyg==", + "dev": true, + "dependencies": { + "undici-types": "~5.26.4" + } }, "node_modules/acorn": { "version": "8.7.1", @@ -372,11 +366,11 @@ "integrity": "sha1-x57Zf380y48robyXkLzDZkdLS3k=" }, "node_modules/axios": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/axios/-/axios-1.1.0.tgz", - "integrity": "sha512-hsJgcqz4JY7f+HZ4cWTrPZ6tZNCNFPTRx1MjRqu/hbpgpHdSCUpLVuplc+jE/h7dOvyANtw/ERA3HC2Rz/QoMg==", + "version": "1.6.8", + "resolved": "https://registry.npmjs.org/axios/-/axios-1.6.8.tgz", + "integrity": "sha512-v/ZHtJDU39mDpyBoFVkETcd/uNdxrWRrg3bKpOKzXFA6Bvqopts6ALSMU3y6ijYxbw2B+wPrIv46egTzJXCLGQ==", "dependencies": { - "follow-redirects": "^1.15.0", + "follow-redirects": "^1.15.6", "form-data": "^4.0.0", "proxy-from-env": "^1.1.0" } @@ -492,27 +486,27 @@ } }, "node_modules/chai": { - "version": "4.3.7", - "resolved": "https://registry.npmjs.org/chai/-/chai-4.3.7.tgz", - "integrity": "sha512-HLnAzZ2iupm25PlN0xFreAlBA5zaBSv3og0DdeGA4Ar6h6rJ3A0rolRUKJhSF2V10GZKDgWF/VmAEsNWjCRB+A==", + "version": "4.4.1", + "resolved": "https://registry.npmjs.org/chai/-/chai-4.4.1.tgz", + "integrity": "sha512-13sOfMv2+DWduEU+/xbun3LScLoqN17nBeTLUsmDfKdoiC1fr0n9PU4guu4AhRcOVFk/sW8LyZWHuhWtQZiF+g==", "dev": true, "dependencies": { "assertion-error": "^1.1.0", - "check-error": "^1.0.2", - "deep-eql": "^4.1.2", - "get-func-name": "^2.0.0", - "loupe": "^2.3.1", + "check-error": "^1.0.3", + "deep-eql": "^4.1.3", + "get-func-name": "^2.0.2", + "loupe": "^2.3.6", "pathval": "^1.1.1", - "type-detect": "^4.0.5" + "type-detect": "^4.0.8" }, "engines": { "node": ">=4" } }, "node_modules/chalk": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.0.tgz", - "integrity": "sha512-qwx12AxXe2Q5xQ43Ac//I6v5aXTipYrSESdOgzrN+9XjgEpyjpKuvSGaN4qE93f7TQTlerQQ8S+EQ0EyDoVL1A==", + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", "dev": true, "dependencies": { "ansi-styles": "^4.1.0", @@ -532,10 +526,13 @@ "dev": true }, "node_modules/check-error": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/check-error/-/check-error-1.0.2.tgz", - "integrity": "sha1-V00xLt2Iu13YkS6Sht1sCu1KrII=", + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/check-error/-/check-error-1.0.3.tgz", + "integrity": "sha512-iKEoDYaRmd1mxM90a2OEfWhjsjPpYPuQ+lMYsoxB126+t8fw7ySEO48nmDg5COTjxDI65/Y2OWpeEHk3ZOe8zg==", "dev": true, + "dependencies": { + "get-func-name": "^2.0.2" + }, "engines": { "node": "*" } @@ -580,9 +577,9 @@ } }, "node_modules/cli-spinners": { - "version": "2.7.0", - "resolved": "https://registry.npmjs.org/cli-spinners/-/cli-spinners-2.7.0.tgz", - "integrity": "sha512-qu3pN8Y3qHNgE2AFweciB1IfMnmZ/fsNTEE+NOFjmGB2F/7rLhnhzppvpCnN4FovtP26k8lHyy9ptEbNwWFLzw==", + "version": "2.9.2", + "resolved": "https://registry.npmjs.org/cli-spinners/-/cli-spinners-2.9.2.tgz", + "integrity": "sha512-ywqV+5MmyL4E7ybXgKys4DugZbX0FC6LnwrhjuykIjnK9k8OQacQ7axGKnjDXWNhns0xot3bZI5h55H8yo9cJg==", "dev": true, "engines": { "node": ">=6" @@ -659,15 +656,15 @@ } }, "node_modules/compare-versions": { - "version": "4.1.3", - "resolved": "https://registry.npmjs.org/compare-versions/-/compare-versions-4.1.3.tgz", - "integrity": "sha512-WQfnbDcrYnGr55UwbxKiQKASnTtNnaAWVi8jZyy8NTpVAXWACSne8lMD1iaIo9AiU6mnuLvSVshCzewVuWxHUg==", + "version": "4.1.4", + "resolved": "https://registry.npmjs.org/compare-versions/-/compare-versions-4.1.4.tgz", + "integrity": "sha512-FemMreK9xNyL8gQevsdRMrvO4lFCkQP7qbuktn1q8ndcNk1+0mz7lgE7b/sNvbhVgY4w6tMN1FDp6aADjqw2rw==", "dev": true }, "node_modules/concat-map": { "version": "0.0.1", "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", - "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=", + "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==", "dev": true }, "node_modules/concurrently": { @@ -798,9 +795,9 @@ } }, "node_modules/deep-eql": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/deep-eql/-/deep-eql-4.1.2.tgz", - "integrity": "sha512-gT18+YW4CcW/DBNTwAmqTtkJh7f9qqScu2qFVlx7kCoeY9tlBu9cUcr7+I+Z/noG8INehS3xQgLpTtd/QUTn4w==", + "version": "4.1.3", + "resolved": "https://registry.npmjs.org/deep-eql/-/deep-eql-4.1.3.tgz", + "integrity": "sha512-WaEtAOpRA1MQ0eohqZjpGD8zdI0Ovsm8mmFhaDN8dvDZzyoUMcYDnf5Y6iu7HTXxf8JDS23qWa4a+hKCDyOPzw==", "dev": true, "dependencies": { "type-detect": "^4.0.0" @@ -953,9 +950,9 @@ } }, "node_modules/follow-redirects": { - "version": "1.15.0", - "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.0.tgz", - "integrity": "sha512-aExlJShTV4qOUOL7yF1U5tvLCB0xQuudbf6toyYA0E/acBNw71mvjFTnLaRp50aQaYocMR0a/RMMBIHeZnGyjQ==", + "version": "1.15.6", + "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.6.tgz", + "integrity": "sha512-wWN62YITEaOpSK584EZXJafH1AGpO8RVgElfkuXbTOrPX4fIfOyEpW/CsiNd8JdYrAoOvafRTOEnvsO++qCqFA==", "funding": [ { "type": "individual", @@ -985,9 +982,9 @@ } }, "node_modules/fs-extra": { - "version": "10.0.1", - "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-10.0.1.tgz", - "integrity": "sha512-NbdoVMZso2Lsrn/QwLXOy6rm0ufY2zEOKCDzJR/0kBsb0E6qed0P3iYK+Ath3BfvXEeu4JhEtXLgILx5psUfag==", + "version": "10.1.0", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-10.1.0.tgz", + "integrity": "sha512-oRXApq54ETRj4eMiFzGnHWGy+zo5raudjuxN0b8H7s/RU2oW0Wvsx9O0ACRN/kRq9E8Vu/ReskGB5o3ji+FzHQ==", "dev": true, "dependencies": { "graceful-fs": "^4.2.0", @@ -1028,24 +1025,24 @@ } }, "node_modules/get-func-name": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/get-func-name/-/get-func-name-2.0.0.tgz", - "integrity": "sha1-6td0q+5y4gQJQzoGY2YCPdaIekE=", + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/get-func-name/-/get-func-name-2.0.2.tgz", + "integrity": "sha512-8vXOvuE167CtIc3OyItco7N/dpRtBbYOsPsXCz7X/PMnlGjYjSGuZJgM1Y7mmew7BKf9BqvLX2tnOVy1BBUsxQ==", "dev": true, "engines": { "node": "*" } }, "node_modules/glob": { - "version": "7.1.6", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.6.tgz", - "integrity": "sha512-LwaxwyZ72Lk7vZINtNNrywX0ZuLyStrdDtabefZKAY5ZGJhVtgdznluResxNmPitE0SAO+O26sWTHeKSI2wMBA==", + "version": "7.2.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", + "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", "dev": true, "dependencies": { "fs.realpath": "^1.0.0", "inflight": "^1.0.4", "inherits": "2", - "minimatch": "^3.0.4", + "minimatch": "^3.1.1", "once": "^1.3.0", "path-is-absolute": "^1.0.0" }, @@ -1069,9 +1066,9 @@ } }, "node_modules/graceful-fs": { - "version": "4.2.10", - "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.10.tgz", - "integrity": "sha512-9ByhssR2fPVsNZj478qUUbKfmL0+t5BDVyjShtyZZLiK7ZDAArFFfopyOTj0M05wE2tJPisA4iTnnXl2YoPvOA==", + "version": "4.2.11", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz", + "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==", "dev": true }, "node_modules/has-flag": { @@ -1141,9 +1138,9 @@ "dev": true }, "node_modules/inquirer": { - "version": "8.2.2", - "resolved": "https://registry.npmjs.org/inquirer/-/inquirer-8.2.2.tgz", - "integrity": "sha512-pG7I/si6K/0X7p1qU+rfWnpTE1UIkTONN1wxtzh0d+dHXtT/JG6qBgLxoyHVsQa8cFABxAPh0pD6uUUHiAoaow==", + "version": "8.2.6", + "resolved": "https://registry.npmjs.org/inquirer/-/inquirer-8.2.6.tgz", + "integrity": "sha512-M1WuAmb7pn9zdFRtQYk26ZBoY043Sse0wVDdk4Bppr+JOXyQYybdtvK+l9wUibhtjdjvtoiNy8tk+EgsYIUqKg==", "dev": true, "dependencies": { "ansi-escapes": "^4.2.1", @@ -1159,26 +1156,25 @@ "rxjs": "^7.5.5", "string-width": "^4.1.0", "strip-ansi": "^6.0.0", - "through": "^2.3.6" + "through": "^2.3.6", + "wrap-ansi": "^6.0.1" }, "engines": { "node": ">=12.0.0" } }, - "node_modules/inquirer/node_modules/chalk": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", - "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "node_modules/inquirer/node_modules/wrap-ansi": { + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-6.2.0.tgz", + "integrity": "sha512-r6lPcBGxZXlIcymEu7InxDMhdW0KDxpLgoFLcguasxCaJ/SOIZwINatK9KY/tf+ZrlywOKU0UDj3ATXUBfxJXA==", "dev": true, "dependencies": { - "ansi-styles": "^4.1.0", - "supports-color": "^7.1.0" + "ansi-styles": "^4.0.0", + "string-width": "^4.1.0", + "strip-ansi": "^6.0.0" }, "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/chalk?sponsor=1" + "node": ">=8" } }, "node_modules/is-binary-path": { @@ -1333,12 +1329,12 @@ } }, "node_modules/loupe": { - "version": "2.3.4", - "resolved": "https://registry.npmjs.org/loupe/-/loupe-2.3.4.tgz", - "integrity": "sha512-OvKfgCC2Ndby6aSTREl5aCCPTNIzlDfQZvZxNUrBrihDhL3xcrYegTblhmEiCrg2kKQz4XsFIaemE5BF4ybSaQ==", + "version": "2.3.7", + "resolved": "https://registry.npmjs.org/loupe/-/loupe-2.3.7.tgz", + "integrity": "sha512-zSMINGVYkdpYSOBmLi0D1Uo7JU9nVdQKrHxC8eYlV+9YKK9WePqAlL7lSlorG/U2Fw1w0hTBmaa/jrQ3UbPHtA==", "dev": true, "dependencies": { - "get-func-name": "^2.0.0" + "get-func-name": "^2.0.1" } }, "node_modules/make-error": { @@ -1388,9 +1384,9 @@ } }, "node_modules/mocha": { - "version": "10.1.0", - "resolved": "https://registry.npmjs.org/mocha/-/mocha-10.1.0.tgz", - "integrity": "sha512-vUF7IYxEoN7XhQpFLxQAEMtE4W91acW4B6En9l97MwE9stL1A9gusXfoHZCLVHDUJ/7V5+lbCM6yMqzo5vNymg==", + "version": "10.4.0", + "resolved": "https://registry.npmjs.org/mocha/-/mocha-10.4.0.tgz", + "integrity": "sha512-eqhGB8JKapEYcC4ytX/xrzKforgEc3j1pGlAXVy3eRwrtAy5/nIfT1SvgGzfN0XZZxeLq0aQWkOUAmqIJiv+bA==", "dev": true, "dependencies": { "ansi-colors": "4.1.1", @@ -1400,13 +1396,12 @@ "diff": "5.0.0", "escape-string-regexp": "4.0.0", "find-up": "5.0.0", - "glob": "7.2.0", + "glob": "8.1.0", "he": "1.2.0", "js-yaml": "4.1.0", "log-symbols": "4.1.0", "minimatch": "5.0.1", "ms": "2.1.3", - "nanoid": "3.3.3", "serialize-javascript": "6.0.0", "strip-json-comments": "3.1.1", "supports-color": "8.1.1", @@ -1421,10 +1416,6 @@ }, "engines": { "node": ">= 14.0.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/mochajs" } }, "node_modules/mocha/node_modules/diff": { @@ -1437,37 +1428,24 @@ } }, "node_modules/mocha/node_modules/glob": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.0.tgz", - "integrity": "sha512-lmLf6gtyrPq8tTjSmrO94wBeQbFR3HbLHbuyD69wuyQkImp2hWqMGB47OX65FBkPffO641IP9jWa1z4ivqG26Q==", + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/glob/-/glob-8.1.0.tgz", + "integrity": "sha512-r8hpEjiQEYlF2QU0df3dS+nxxSIreXQS1qRhMJM0Q5NDdR386C7jb7Hwwod8Fgiuex+k0GFjgft18yvxm5XoCQ==", "dev": true, "dependencies": { "fs.realpath": "^1.0.0", "inflight": "^1.0.4", "inherits": "2", - "minimatch": "^3.0.4", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" + "minimatch": "^5.0.1", + "once": "^1.3.0" }, "engines": { - "node": "*" + "node": ">=12" }, "funding": { "url": "https://github.com/sponsors/isaacs" } }, - "node_modules/mocha/node_modules/glob/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "dependencies": { - "brace-expansion": "^1.1.7" - }, - "engines": { - "node": "*" - } - }, "node_modules/mocha/node_modules/minimatch": { "version": "5.0.1", "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.0.1.tgz", @@ -1516,22 +1494,10 @@ "integrity": "sha512-nnbWWOkoWyUsTjKrhgD0dcz22mdkSnpYqbEjIm2nhwhuxlSkpywJmBo8h0ZqJdkp73mb90SssHkN4rsRaBAfAA==", "dev": true }, - "node_modules/nanoid": { - "version": "3.3.3", - "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.3.tgz", - "integrity": "sha512-p1sjXuopFs0xg+fPASzQ28agW1oHD7xDsd9Xkf3T15H3c/cifrFHVwrh74PdoklAPi+i7MdRsE47vm2r6JoB+w==", - "dev": true, - "bin": { - "nanoid": "bin/nanoid.cjs" - }, - "engines": { - "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" - } - }, "node_modules/node-fetch": { - "version": "2.6.7", - "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.7.tgz", - "integrity": "sha512-ZjMPFEfVx5j+y2yF35Kzx5sF7kDzxuDj6ziH4FFbOp87zKDZNx8yExJIb05OGF4Nlt9IHFIMBkRl41VdvcNdbQ==", + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", + "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==", "dev": true, "dependencies": { "whatwg-url": "^5.0.0" @@ -1557,15 +1523,6 @@ "node": ">=0.10.0" } }, - "node_modules/object-hash": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/object-hash/-/object-hash-3.0.0.tgz", - "integrity": "sha512-RSn9F68PjH9HqtltsSnqYC1XXoWe9Bju5+213R98cNGttag9q9yAOTzdbsqvIa7aNm5WffBZFpWYr2aWrklWAw==", - "dev": true, - "engines": { - "node": ">= 6" - } - }, "node_modules/once": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", @@ -1664,7 +1621,7 @@ "node_modules/path-is-absolute": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", - "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=", + "integrity": "sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==", "dev": true, "engines": { "node": ">=0.10.0" @@ -1712,9 +1669,9 @@ } }, "node_modules/readable-stream": { - "version": "3.6.0", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.0.tgz", - "integrity": "sha512-BViHy7LKeTz4oNnkcLJ+lVSL6vpiFeX6/d3oSH8zCW7UxP2onchk+vTGB143xuFjHS3deTgkKoXXymXqymiIdA==", + "version": "3.6.2", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz", + "integrity": "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==", "dev": true, "dependencies": { "inherits": "^2.0.3", @@ -1775,20 +1732,14 @@ } }, "node_modules/rxjs": { - "version": "7.5.5", - "resolved": "https://registry.npmjs.org/rxjs/-/rxjs-7.5.5.tgz", - "integrity": "sha512-sy+H0pQofO95VDmFLzyaw9xNJU4KTRSwQIGM6+iG3SypAtCiLDzpeG8sJrNCWn2Up9km+KhkvTdbkrdy+yzZdw==", + "version": "7.8.1", + "resolved": "https://registry.npmjs.org/rxjs/-/rxjs-7.8.1.tgz", + "integrity": "sha512-AA3TVj+0A2iuIoQkWEK/tqFjBq2j+6PO6Y0zJcvzLAFhEFIO3HL0vls9hWLncZbAAbK0mar7oZ4V079I/qPMxg==", "dev": true, "dependencies": { "tslib": "^2.1.0" } }, - "node_modules/rxjs/node_modules/tslib": { - "version": "2.4.0", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.4.0.tgz", - "integrity": "sha512-d6xOpEDfsi2CZVlPQzGeux8XMwLT9hssAsaPYExaQMuYskwb+x1x7J371tWlbBdWHroy99KnVB6qIkUbs5X3UQ==", - "dev": true - }, "node_modules/safe-buffer": { "version": "5.2.1", "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", @@ -1941,9 +1892,9 @@ } }, "node_modules/ts-node": { - "version": "10.9.1", - "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.9.1.tgz", - "integrity": "sha512-NtVysVPkxxrwFGUUxGYhfux8k78pQB3JqYBXlLRZgdGUqTO5wU/UyHop5p70iEbGhB7q5KmiZiU0Y3KlJrScEw==", + "version": "10.9.2", + "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.9.2.tgz", + "integrity": "sha512-f0FFpIdcHgn8zcPSbf1dRevwt047YMnaiJM3u2w2RewrB+fob/zePZcrOyQoLMMO7aBIddLcQIEK5dYjkLnGrQ==", "dev": true, "dependencies": { "@cspotcode/source-map-support": "^0.8.0", @@ -1984,9 +1935,9 @@ } }, "node_modules/tslib": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.0.3.tgz", - "integrity": "sha512-uZtkfKblCEQtZKBF6EBXVZeQNl82yqtDQdv+eck8u7tdPxjLu2/lp5/uPW+um2tpuxINHWy3GhiccY7QgEaVHQ==", + "version": "2.6.2", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.6.2.tgz", + "integrity": "sha512-AEYxH93jGFPn/a2iVAwW87VuUIkR1FVUKB77NwMF7nBTDkDrrT/Hpt/IrCJ0QXhW27jTBDcf5ZY7w6RiqTMw2Q==", "dev": true }, "node_modules/type-detect": { @@ -2011,22 +1962,40 @@ } }, "node_modules/typescript": { - "version": "4.9.3", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.9.3.tgz", - "integrity": "sha512-CIfGzTelbKNEnLpLdGFgdyKhG23CKdKgQPOBc+OUNrkJ2vr+KSzsSV5kq5iWhEQbok+quxgGzrAtGWCyU7tHnA==", + "version": "5.4.4", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.4.4.tgz", + "integrity": "sha512-dGE2Vv8cpVvw28v8HCPqyb08EzbBURxDpuhJvTrusShUfGnhHBafDsLdS1EhhxyL6BJQE+2cT3dDPAv+MQ6oLw==", "dev": true, "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" }, "engines": { - "node": ">=4.2.0" + "node": ">=14.17" + } + }, + "node_modules/uid": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/uid/-/uid-2.0.2.tgz", + "integrity": "sha512-u3xV3X7uzvi5b1MncmZo3i2Aw222Zk1keqLA1YkHldREkAhAqi65wuPfe7lHx8H/Wzy+8CE7S7uS3jekIM5s8g==", + "dev": true, + "dependencies": { + "@lukeed/csprng": "^1.0.0" + }, + "engines": { + "node": ">=8" } }, + "node_modules/undici-types": { + "version": "5.26.5", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-5.26.5.tgz", + "integrity": "sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA==", + "dev": true + }, "node_modules/universalify": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.0.tgz", - "integrity": "sha512-hAZsKq7Yy11Zu1DE0OzWjw7nnLZmJZYTDZZyEFHZdUhV8FkH5MCfoU1XMaxXovpyW5nq5scPqq0ZDP9Zyl04oQ==", + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.1.tgz", + "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==", "dev": true, "engines": { "node": ">= 10.0.0" @@ -2038,15 +2007,6 @@ "integrity": "sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==", "dev": true }, - "node_modules/uuid": { - "version": "8.3.2", - "resolved": "https://registry.npmjs.org/uuid/-/uuid-8.3.2.tgz", - "integrity": "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==", - "dev": true, - "bin": { - "uuid": "dist/bin/uuid" - } - }, "node_modules/v8-compile-cache-lib": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.1.tgz", @@ -2212,56 +2172,42 @@ "@jridgewell/sourcemap-codec": "^1.4.10" } }, + "@lukeed/csprng": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@lukeed/csprng/-/csprng-1.1.0.tgz", + "integrity": "sha512-Z7C/xXCiGWsg0KuKsHTKJxbWhpI3Vs5GwLfOean7MGyVFGqdRgBbAjOCh6u4bbjPc/8MJ2pZmK/0DLdCbivLDA==", + "dev": true + }, + "@nestjs/axios": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/@nestjs/axios/-/axios-3.0.1.tgz", + "integrity": "sha512-VlOZhAGDmOoFdsmewn8AyClAdGpKXQQaY1+3PGB+g6ceurGIdTxZgRX3VXc1T6Zs60PedWjg3A82TDOB05mrzQ==", + "dev": true, + "requires": {} + }, "@nestjs/common": { - "version": "8.4.4", - "resolved": "https://registry.npmjs.org/@nestjs/common/-/common-8.4.4.tgz", - "integrity": "sha512-QHi7QcgH/5Jinz+SCfIZJkFHc6Cch1YsAEGFEhi6wSp6MILb0sJMQ1CX06e9tCOAjSlBwaJj4PH0eFCVau5v9Q==", + "version": "10.3.0", + "resolved": "https://registry.npmjs.org/@nestjs/common/-/common-10.3.0.tgz", + "integrity": "sha512-DGv34UHsZBxCM3H5QGE2XE/+oLJzz5+714JQjBhjD9VccFlQs3LRxo/epso4l7nJIiNlZkPyIUC8WzfU/5RTsQ==", "dev": true, "requires": { - "axios": "0.26.1", "iterare": "1.2.1", - "tslib": "2.3.1", - "uuid": "8.3.2" - }, - "dependencies": { - "axios": { - "version": "0.26.1", - "resolved": "https://registry.npmjs.org/axios/-/axios-0.26.1.tgz", - "integrity": "sha512-fPwcX4EvnSHuInCMItEhAGnaSEXRBjtzh9fOtsE6E1G6p7vl7edEeZe11QHf18+6+9gR5PbKV/sGKNaD8YaMeA==", - "dev": true, - "requires": { - "follow-redirects": "^1.14.8" - } - }, - "tslib": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.3.1.tgz", - "integrity": "sha512-77EbyPPpMz+FRFRuAFlWMtmgUWGe9UOG2Z25NqCwiIjRhOf5iKGuzSe5P2w1laq+FkRy4p+PCuVkJSGkzTEKVw==", - "dev": true - } + "tslib": "2.6.2", + "uid": "2.0.2" } }, "@nestjs/core": { - "version": "8.4.4", - "resolved": "https://registry.npmjs.org/@nestjs/core/-/core-8.4.4.tgz", - "integrity": "sha512-Ef3yJPuzAttpNfehnGqIV5kHIL9SHptB5F4ERxoU7pT61H3xiYpZw6hSjx68cJO7cc6rm7/N+b4zeuJvFHtvBg==", + "version": "10.3.0", + "resolved": "https://registry.npmjs.org/@nestjs/core/-/core-10.3.0.tgz", + "integrity": "sha512-N06P5ncknW/Pm8bj964WvLIZn2gNhHliCBoAO1LeBvNImYkecqKcrmLbY49Fa1rmMfEM3MuBHeDys3edeuYAOA==", "dev": true, "requires": { "@nuxtjs/opencollective": "0.3.2", "fast-safe-stringify": "2.1.1", "iterare": "1.2.1", - "object-hash": "3.0.0", "path-to-regexp": "3.2.0", - "tslib": "2.3.1", - "uuid": "8.3.2" - }, - "dependencies": { - "tslib": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.3.1.tgz", - "integrity": "sha512-77EbyPPpMz+FRFRuAFlWMtmgUWGe9UOG2Z25NqCwiIjRhOf5iKGuzSe5P2w1laq+FkRy4p+PCuVkJSGkzTEKVw==", - "dev": true - } + "tslib": "2.6.2", + "uid": "2.0.2" } }, "@nuxtjs/opencollective": { @@ -2276,36 +2222,39 @@ } }, "@openapitools/openapi-generator-cli": { - "version": "2.5.2", - "resolved": "https://registry.npmjs.org/@openapitools/openapi-generator-cli/-/openapi-generator-cli-2.5.2.tgz", - "integrity": "sha512-FLgkjzpDiHVsH821db0VDSElDoA6TcspGyq3RD4zLBJaJhbSsRwr4u87sNoyuHKBg4OMJbZMT4iJxAhkosKrzw==", + "version": "2.13.1", + "resolved": "https://registry.npmjs.org/@openapitools/openapi-generator-cli/-/openapi-generator-cli-2.13.1.tgz", + "integrity": "sha512-WJB6MsFXlA69mpKCuR3hBsdFr7MptNhoIGlyvoYEorBQEg3cd6n1gACHx0fz20B3e03/imvorQlNMsrHTIeU9w==", "dev": true, "requires": { - "@nestjs/common": "8.4.4", - "@nestjs/core": "8.4.4", + "@nestjs/axios": "3.0.1", + "@nestjs/common": "10.3.0", + "@nestjs/core": "10.3.0", "@nuxtjs/opencollective": "0.3.2", + "axios": "1.6.5", "chalk": "4.1.2", "commander": "8.3.0", - "compare-versions": "4.1.3", + "compare-versions": "4.1.4", "concurrently": "6.5.1", "console.table": "0.10.0", - "fs-extra": "10.0.1", - "glob": "7.1.6", - "inquirer": "8.2.2", + "fs-extra": "10.1.0", + "glob": "7.2.3", + "inquirer": "8.2.6", "lodash": "4.17.21", "reflect-metadata": "0.1.13", - "rxjs": "7.5.5", - "tslib": "2.0.3" + "rxjs": "7.8.1", + "tslib": "2.6.2" }, "dependencies": { - "chalk": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", - "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "axios": { + "version": "1.6.5", + "resolved": "https://registry.npmjs.org/axios/-/axios-1.6.5.tgz", + "integrity": "sha512-Ii012v05KEVuUoFWmMW/UQv9aRIc3ZwkWDcM+h5Il8izZCtRVpDUfwpoFf7eOtajT3QiGR4yDUx7lPqHJULgbg==", "dev": true, "requires": { - "ansi-styles": "^4.1.0", - "supports-color": "^7.1.0" + "follow-redirects": "^1.15.4", + "form-data": "^4.0.0", + "proxy-from-env": "^1.1.0" } } } @@ -2341,16 +2290,19 @@ "dev": true }, "@types/mocha": { - "version": "10.0.0", - "resolved": "https://registry.npmjs.org/@types/mocha/-/mocha-10.0.0.tgz", - "integrity": "sha512-rADY+HtTOA52l9VZWtgQfn4p+UDVM2eDVkMZT1I6syp0YKxW2F9v+0pbRZLsvskhQv/vMb6ZfCay81GHbz5SHg==", + "version": "10.0.6", + "resolved": "https://registry.npmjs.org/@types/mocha/-/mocha-10.0.6.tgz", + "integrity": "sha512-dJvrYWxP/UcXm36Qn36fxhUKu8A/xMRXVT2cliFF1Z7UA9liG5Psj3ezNSZw+5puH2czDXRLcXQxf8JbJt0ejg==", "dev": true }, "@types/node": { - "version": "18.11.15", - "resolved": "https://registry.npmjs.org/@types/node/-/node-18.11.15.tgz", - "integrity": "sha512-VkhBbVo2+2oozlkdHXLrb3zjsRkpdnaU2bXmX8Wgle3PUi569eLRaHGlgETQHR7lLL1w7GiG3h9SnePhxNDecw==", - "dev": true + "version": "18.19.30", + "resolved": "https://registry.npmjs.org/@types/node/-/node-18.19.30.tgz", + "integrity": "sha512-453z1zPuJLVDbyahaa1sSD5C2sht6ZpHp5rgJNs+H8YGqhluCXcuOUmBYsAo0Tos0cHySJ3lVUGbGgLlqIkpyg==", + "dev": true, + "requires": { + "undici-types": "~5.26.4" + } }, "acorn": { "version": "8.7.1", @@ -2428,11 +2380,11 @@ "integrity": "sha1-x57Zf380y48robyXkLzDZkdLS3k=" }, "axios": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/axios/-/axios-1.1.0.tgz", - "integrity": "sha512-hsJgcqz4JY7f+HZ4cWTrPZ6tZNCNFPTRx1MjRqu/hbpgpHdSCUpLVuplc+jE/h7dOvyANtw/ERA3HC2Rz/QoMg==", + "version": "1.6.8", + "resolved": "https://registry.npmjs.org/axios/-/axios-1.6.8.tgz", + "integrity": "sha512-v/ZHtJDU39mDpyBoFVkETcd/uNdxrWRrg3bKpOKzXFA6Bvqopts6ALSMU3y6ijYxbw2B+wPrIv46egTzJXCLGQ==", "requires": { - "follow-redirects": "^1.15.0", + "follow-redirects": "^1.15.6", "form-data": "^4.0.0", "proxy-from-env": "^1.1.0" } @@ -2508,24 +2460,24 @@ "dev": true }, "chai": { - "version": "4.3.7", - "resolved": "https://registry.npmjs.org/chai/-/chai-4.3.7.tgz", - "integrity": "sha512-HLnAzZ2iupm25PlN0xFreAlBA5zaBSv3og0DdeGA4Ar6h6rJ3A0rolRUKJhSF2V10GZKDgWF/VmAEsNWjCRB+A==", + "version": "4.4.1", + "resolved": "https://registry.npmjs.org/chai/-/chai-4.4.1.tgz", + "integrity": "sha512-13sOfMv2+DWduEU+/xbun3LScLoqN17nBeTLUsmDfKdoiC1fr0n9PU4guu4AhRcOVFk/sW8LyZWHuhWtQZiF+g==", "dev": true, "requires": { "assertion-error": "^1.1.0", - "check-error": "^1.0.2", - "deep-eql": "^4.1.2", - "get-func-name": "^2.0.0", - "loupe": "^2.3.1", + "check-error": "^1.0.3", + "deep-eql": "^4.1.3", + "get-func-name": "^2.0.2", + "loupe": "^2.3.6", "pathval": "^1.1.1", - "type-detect": "^4.0.5" + "type-detect": "^4.0.8" } }, "chalk": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.0.tgz", - "integrity": "sha512-qwx12AxXe2Q5xQ43Ac//I6v5aXTipYrSESdOgzrN+9XjgEpyjpKuvSGaN4qE93f7TQTlerQQ8S+EQ0EyDoVL1A==", + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", "dev": true, "requires": { "ansi-styles": "^4.1.0", @@ -2539,10 +2491,13 @@ "dev": true }, "check-error": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/check-error/-/check-error-1.0.2.tgz", - "integrity": "sha1-V00xLt2Iu13YkS6Sht1sCu1KrII=", - "dev": true + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/check-error/-/check-error-1.0.3.tgz", + "integrity": "sha512-iKEoDYaRmd1mxM90a2OEfWhjsjPpYPuQ+lMYsoxB126+t8fw7ySEO48nmDg5COTjxDI65/Y2OWpeEHk3ZOe8zg==", + "dev": true, + "requires": { + "get-func-name": "^2.0.2" + } }, "chokidar": { "version": "3.5.3", @@ -2570,9 +2525,9 @@ } }, "cli-spinners": { - "version": "2.7.0", - "resolved": "https://registry.npmjs.org/cli-spinners/-/cli-spinners-2.7.0.tgz", - "integrity": "sha512-qu3pN8Y3qHNgE2AFweciB1IfMnmZ/fsNTEE+NOFjmGB2F/7rLhnhzppvpCnN4FovtP26k8lHyy9ptEbNwWFLzw==", + "version": "2.9.2", + "resolved": "https://registry.npmjs.org/cli-spinners/-/cli-spinners-2.9.2.tgz", + "integrity": "sha512-ywqV+5MmyL4E7ybXgKys4DugZbX0FC6LnwrhjuykIjnK9k8OQacQ7axGKnjDXWNhns0xot3bZI5h55H8yo9cJg==", "dev": true }, "cli-width": { @@ -2628,15 +2583,15 @@ "dev": true }, "compare-versions": { - "version": "4.1.3", - "resolved": "https://registry.npmjs.org/compare-versions/-/compare-versions-4.1.3.tgz", - "integrity": "sha512-WQfnbDcrYnGr55UwbxKiQKASnTtNnaAWVi8jZyy8NTpVAXWACSne8lMD1iaIo9AiU6mnuLvSVshCzewVuWxHUg==", + "version": "4.1.4", + "resolved": "https://registry.npmjs.org/compare-versions/-/compare-versions-4.1.4.tgz", + "integrity": "sha512-FemMreK9xNyL8gQevsdRMrvO4lFCkQP7qbuktn1q8ndcNk1+0mz7lgE7b/sNvbhVgY4w6tMN1FDp6aADjqw2rw==", "dev": true }, "concat-map": { "version": "0.0.1", "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", - "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=", + "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==", "dev": true }, "concurrently": { @@ -2732,9 +2687,9 @@ "dev": true }, "deep-eql": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/deep-eql/-/deep-eql-4.1.2.tgz", - "integrity": "sha512-gT18+YW4CcW/DBNTwAmqTtkJh7f9qqScu2qFVlx7kCoeY9tlBu9cUcr7+I+Z/noG8INehS3xQgLpTtd/QUTn4w==", + "version": "4.1.3", + "resolved": "https://registry.npmjs.org/deep-eql/-/deep-eql-4.1.3.tgz", + "integrity": "sha512-WaEtAOpRA1MQ0eohqZjpGD8zdI0Ovsm8mmFhaDN8dvDZzyoUMcYDnf5Y6iu7HTXxf8JDS23qWa4a+hKCDyOPzw==", "dev": true, "requires": { "type-detect": "^4.0.0" @@ -2847,9 +2802,9 @@ "dev": true }, "follow-redirects": { - "version": "1.15.0", - "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.0.tgz", - "integrity": "sha512-aExlJShTV4qOUOL7yF1U5tvLCB0xQuudbf6toyYA0E/acBNw71mvjFTnLaRp50aQaYocMR0a/RMMBIHeZnGyjQ==" + "version": "1.15.6", + "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.6.tgz", + "integrity": "sha512-wWN62YITEaOpSK584EZXJafH1AGpO8RVgElfkuXbTOrPX4fIfOyEpW/CsiNd8JdYrAoOvafRTOEnvsO++qCqFA==" }, "form-data": { "version": "4.0.0", @@ -2862,9 +2817,9 @@ } }, "fs-extra": { - "version": "10.0.1", - "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-10.0.1.tgz", - "integrity": "sha512-NbdoVMZso2Lsrn/QwLXOy6rm0ufY2zEOKCDzJR/0kBsb0E6qed0P3iYK+Ath3BfvXEeu4JhEtXLgILx5psUfag==", + "version": "10.1.0", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-10.1.0.tgz", + "integrity": "sha512-oRXApq54ETRj4eMiFzGnHWGy+zo5raudjuxN0b8H7s/RU2oW0Wvsx9O0ACRN/kRq9E8Vu/ReskGB5o3ji+FzHQ==", "dev": true, "requires": { "graceful-fs": "^4.2.0", @@ -2892,21 +2847,21 @@ "dev": true }, "get-func-name": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/get-func-name/-/get-func-name-2.0.0.tgz", - "integrity": "sha1-6td0q+5y4gQJQzoGY2YCPdaIekE=", + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/get-func-name/-/get-func-name-2.0.2.tgz", + "integrity": "sha512-8vXOvuE167CtIc3OyItco7N/dpRtBbYOsPsXCz7X/PMnlGjYjSGuZJgM1Y7mmew7BKf9BqvLX2tnOVy1BBUsxQ==", "dev": true }, "glob": { - "version": "7.1.6", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.6.tgz", - "integrity": "sha512-LwaxwyZ72Lk7vZINtNNrywX0ZuLyStrdDtabefZKAY5ZGJhVtgdznluResxNmPitE0SAO+O26sWTHeKSI2wMBA==", + "version": "7.2.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", + "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", "dev": true, "requires": { "fs.realpath": "^1.0.0", "inflight": "^1.0.4", "inherits": "2", - "minimatch": "^3.0.4", + "minimatch": "^3.1.1", "once": "^1.3.0", "path-is-absolute": "^1.0.0" } @@ -2921,9 +2876,9 @@ } }, "graceful-fs": { - "version": "4.2.10", - "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.10.tgz", - "integrity": "sha512-9ByhssR2fPVsNZj478qUUbKfmL0+t5BDVyjShtyZZLiK7ZDAArFFfopyOTj0M05wE2tJPisA4iTnnXl2YoPvOA==", + "version": "4.2.11", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz", + "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==", "dev": true }, "has-flag": { @@ -2970,9 +2925,9 @@ "dev": true }, "inquirer": { - "version": "8.2.2", - "resolved": "https://registry.npmjs.org/inquirer/-/inquirer-8.2.2.tgz", - "integrity": "sha512-pG7I/si6K/0X7p1qU+rfWnpTE1UIkTONN1wxtzh0d+dHXtT/JG6qBgLxoyHVsQa8cFABxAPh0pD6uUUHiAoaow==", + "version": "8.2.6", + "resolved": "https://registry.npmjs.org/inquirer/-/inquirer-8.2.6.tgz", + "integrity": "sha512-M1WuAmb7pn9zdFRtQYk26ZBoY043Sse0wVDdk4Bppr+JOXyQYybdtvK+l9wUibhtjdjvtoiNy8tk+EgsYIUqKg==", "dev": true, "requires": { "ansi-escapes": "^4.2.1", @@ -2988,17 +2943,19 @@ "rxjs": "^7.5.5", "string-width": "^4.1.0", "strip-ansi": "^6.0.0", - "through": "^2.3.6" + "through": "^2.3.6", + "wrap-ansi": "^6.0.1" }, "dependencies": { - "chalk": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", - "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "wrap-ansi": { + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-6.2.0.tgz", + "integrity": "sha512-r6lPcBGxZXlIcymEu7InxDMhdW0KDxpLgoFLcguasxCaJ/SOIZwINatK9KY/tf+ZrlywOKU0UDj3ATXUBfxJXA==", "dev": true, "requires": { - "ansi-styles": "^4.1.0", - "supports-color": "^7.1.0" + "ansi-styles": "^4.0.0", + "string-width": "^4.1.0", + "strip-ansi": "^6.0.0" } } } @@ -3108,12 +3065,12 @@ } }, "loupe": { - "version": "2.3.4", - "resolved": "https://registry.npmjs.org/loupe/-/loupe-2.3.4.tgz", - "integrity": "sha512-OvKfgCC2Ndby6aSTREl5aCCPTNIzlDfQZvZxNUrBrihDhL3xcrYegTblhmEiCrg2kKQz4XsFIaemE5BF4ybSaQ==", + "version": "2.3.7", + "resolved": "https://registry.npmjs.org/loupe/-/loupe-2.3.7.tgz", + "integrity": "sha512-zSMINGVYkdpYSOBmLi0D1Uo7JU9nVdQKrHxC8eYlV+9YKK9WePqAlL7lSlorG/U2Fw1w0hTBmaa/jrQ3UbPHtA==", "dev": true, "requires": { - "get-func-name": "^2.0.0" + "get-func-name": "^2.0.1" } }, "make-error": { @@ -3151,9 +3108,9 @@ } }, "mocha": { - "version": "10.1.0", - "resolved": "https://registry.npmjs.org/mocha/-/mocha-10.1.0.tgz", - "integrity": "sha512-vUF7IYxEoN7XhQpFLxQAEMtE4W91acW4B6En9l97MwE9stL1A9gusXfoHZCLVHDUJ/7V5+lbCM6yMqzo5vNymg==", + "version": "10.4.0", + "resolved": "https://registry.npmjs.org/mocha/-/mocha-10.4.0.tgz", + "integrity": "sha512-eqhGB8JKapEYcC4ytX/xrzKforgEc3j1pGlAXVy3eRwrtAy5/nIfT1SvgGzfN0XZZxeLq0aQWkOUAmqIJiv+bA==", "dev": true, "requires": { "ansi-colors": "4.1.1", @@ -3163,13 +3120,12 @@ "diff": "5.0.0", "escape-string-regexp": "4.0.0", "find-up": "5.0.0", - "glob": "7.2.0", + "glob": "8.1.0", "he": "1.2.0", "js-yaml": "4.1.0", "log-symbols": "4.1.0", "minimatch": "5.0.1", "ms": "2.1.3", - "nanoid": "3.3.3", "serialize-javascript": "6.0.0", "strip-json-comments": "3.1.1", "supports-color": "8.1.1", @@ -3186,28 +3142,16 @@ "dev": true }, "glob": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.0.tgz", - "integrity": "sha512-lmLf6gtyrPq8tTjSmrO94wBeQbFR3HbLHbuyD69wuyQkImp2hWqMGB47OX65FBkPffO641IP9jWa1z4ivqG26Q==", + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/glob/-/glob-8.1.0.tgz", + "integrity": "sha512-r8hpEjiQEYlF2QU0df3dS+nxxSIreXQS1qRhMJM0Q5NDdR386C7jb7Hwwod8Fgiuex+k0GFjgft18yvxm5XoCQ==", "dev": true, "requires": { "fs.realpath": "^1.0.0", "inflight": "^1.0.4", "inherits": "2", - "minimatch": "^3.0.4", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" - }, - "dependencies": { - "minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "requires": { - "brace-expansion": "^1.1.7" - } - } + "minimatch": "^5.0.1", + "once": "^1.3.0" } }, "minimatch": { @@ -3253,16 +3197,10 @@ "integrity": "sha512-nnbWWOkoWyUsTjKrhgD0dcz22mdkSnpYqbEjIm2nhwhuxlSkpywJmBo8h0ZqJdkp73mb90SssHkN4rsRaBAfAA==", "dev": true }, - "nanoid": { - "version": "3.3.3", - "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.3.tgz", - "integrity": "sha512-p1sjXuopFs0xg+fPASzQ28agW1oHD7xDsd9Xkf3T15H3c/cifrFHVwrh74PdoklAPi+i7MdRsE47vm2r6JoB+w==", - "dev": true - }, "node-fetch": { - "version": "2.6.7", - "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.7.tgz", - "integrity": "sha512-ZjMPFEfVx5j+y2yF35Kzx5sF7kDzxuDj6ziH4FFbOp87zKDZNx8yExJIb05OGF4Nlt9IHFIMBkRl41VdvcNdbQ==", + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", + "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==", "dev": true, "requires": { "whatwg-url": "^5.0.0" @@ -3274,12 +3212,6 @@ "integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==", "dev": true }, - "object-hash": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/object-hash/-/object-hash-3.0.0.tgz", - "integrity": "sha512-RSn9F68PjH9HqtltsSnqYC1XXoWe9Bju5+213R98cNGttag9q9yAOTzdbsqvIa7aNm5WffBZFpWYr2aWrklWAw==", - "dev": true - }, "once": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", @@ -3348,7 +3280,7 @@ "path-is-absolute": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", - "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=", + "integrity": "sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==", "dev": true }, "path-to-regexp": { @@ -3384,9 +3316,9 @@ } }, "readable-stream": { - "version": "3.6.0", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.0.tgz", - "integrity": "sha512-BViHy7LKeTz4oNnkcLJ+lVSL6vpiFeX6/d3oSH8zCW7UxP2onchk+vTGB143xuFjHS3deTgkKoXXymXqymiIdA==", + "version": "3.6.2", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz", + "integrity": "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==", "dev": true, "requires": { "inherits": "^2.0.3", @@ -3432,20 +3364,12 @@ "dev": true }, "rxjs": { - "version": "7.5.5", - "resolved": "https://registry.npmjs.org/rxjs/-/rxjs-7.5.5.tgz", - "integrity": "sha512-sy+H0pQofO95VDmFLzyaw9xNJU4KTRSwQIGM6+iG3SypAtCiLDzpeG8sJrNCWn2Up9km+KhkvTdbkrdy+yzZdw==", + "version": "7.8.1", + "resolved": "https://registry.npmjs.org/rxjs/-/rxjs-7.8.1.tgz", + "integrity": "sha512-AA3TVj+0A2iuIoQkWEK/tqFjBq2j+6PO6Y0zJcvzLAFhEFIO3HL0vls9hWLncZbAAbK0mar7oZ4V079I/qPMxg==", "dev": true, "requires": { "tslib": "^2.1.0" - }, - "dependencies": { - "tslib": { - "version": "2.4.0", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.4.0.tgz", - "integrity": "sha512-d6xOpEDfsi2CZVlPQzGeux8XMwLT9hssAsaPYExaQMuYskwb+x1x7J371tWlbBdWHroy99KnVB6qIkUbs5X3UQ==", - "dev": true - } } }, "safe-buffer": { @@ -3562,9 +3486,9 @@ "dev": true }, "ts-node": { - "version": "10.9.1", - "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.9.1.tgz", - "integrity": "sha512-NtVysVPkxxrwFGUUxGYhfux8k78pQB3JqYBXlLRZgdGUqTO5wU/UyHop5p70iEbGhB7q5KmiZiU0Y3KlJrScEw==", + "version": "10.9.2", + "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.9.2.tgz", + "integrity": "sha512-f0FFpIdcHgn8zcPSbf1dRevwt047YMnaiJM3u2w2RewrB+fob/zePZcrOyQoLMMO7aBIddLcQIEK5dYjkLnGrQ==", "dev": true, "requires": { "@cspotcode/source-map-support": "^0.8.0", @@ -3583,9 +3507,9 @@ } }, "tslib": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.0.3.tgz", - "integrity": "sha512-uZtkfKblCEQtZKBF6EBXVZeQNl82yqtDQdv+eck8u7tdPxjLu2/lp5/uPW+um2tpuxINHWy3GhiccY7QgEaVHQ==", + "version": "2.6.2", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.6.2.tgz", + "integrity": "sha512-AEYxH93jGFPn/a2iVAwW87VuUIkR1FVUKB77NwMF7nBTDkDrrT/Hpt/IrCJ0QXhW27jTBDcf5ZY7w6RiqTMw2Q==", "dev": true }, "type-detect": { @@ -3601,15 +3525,30 @@ "dev": true }, "typescript": { - "version": "4.9.3", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.9.3.tgz", - "integrity": "sha512-CIfGzTelbKNEnLpLdGFgdyKhG23CKdKgQPOBc+OUNrkJ2vr+KSzsSV5kq5iWhEQbok+quxgGzrAtGWCyU7tHnA==", + "version": "5.4.4", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.4.4.tgz", + "integrity": "sha512-dGE2Vv8cpVvw28v8HCPqyb08EzbBURxDpuhJvTrusShUfGnhHBafDsLdS1EhhxyL6BJQE+2cT3dDPAv+MQ6oLw==", + "dev": true + }, + "uid": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/uid/-/uid-2.0.2.tgz", + "integrity": "sha512-u3xV3X7uzvi5b1MncmZo3i2Aw222Zk1keqLA1YkHldREkAhAqi65wuPfe7lHx8H/Wzy+8CE7S7uS3jekIM5s8g==", + "dev": true, + "requires": { + "@lukeed/csprng": "^1.0.0" + } + }, + "undici-types": { + "version": "5.26.5", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-5.26.5.tgz", + "integrity": "sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA==", "dev": true }, "universalify": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.0.tgz", - "integrity": "sha512-hAZsKq7Yy11Zu1DE0OzWjw7nnLZmJZYTDZZyEFHZdUhV8FkH5MCfoU1XMaxXovpyW5nq5scPqq0ZDP9Zyl04oQ==", + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.1.tgz", + "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==", "dev": true }, "util-deprecate": { @@ -3618,12 +3557,6 @@ "integrity": "sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==", "dev": true }, - "uuid": { - "version": "8.3.2", - "resolved": "https://registry.npmjs.org/uuid/-/uuid-8.3.2.tgz", - "integrity": "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==", - "dev": true - }, "v8-compile-cache-lib": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.1.tgz", diff --git a/package.json b/package.json index 538d816..5f9b85e 100644 --- a/package.json +++ b/package.json @@ -1,9 +1,9 @@ { "name": "killbill", - "version": "0.24.0", + "version": "0.24.10", "description": "Kill Bill client library", "homepage": "https://github.com/killbill/killbill-client-js", - "author": "Kill Bill core team (http://kill-bill.org/)", + "author": "Kill Bill core team (https://killbill.io)", "repository": { "type": "git", "url": "git://github.com/killbill/killbill-client-js.git" @@ -20,16 +20,16 @@ "prepublishOnly": "npm run build" }, "dependencies": { - "axios": "^1.1.0" + "axios": "^1.6.8" }, "devDependencies": { - "@openapitools/openapi-generator-cli": "^2.5.1", + "@openapitools/openapi-generator-cli": "^2.13.1", "@types/chai": "^4.2.12", "@types/mocha": "^10.0.0", "@types/node": "^18.0.0", "chai": "^4.2.0", "mocha": "^10.0.0", "ts-node": "^10.7.0", - "typescript": "^4.0.3" + "typescript": "^5.4.4" } } From ad1bbaf0db7bd93ebb2c7a923cd1fc7be48a701b Mon Sep 17 00:00:00 2001 From: xsalefter Date: Sun, 7 Apr 2024 01:11:55 +0700 Subject: [PATCH 2/4] update killbill:image and db:image --- docker/docker-compose.ci.mysql.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docker/docker-compose.ci.mysql.yml b/docker/docker-compose.ci.mysql.yml index 45102f0..5d9477b 100644 --- a/docker/docker-compose.ci.mysql.yml +++ b/docker/docker-compose.ci.mysql.yml @@ -3,7 +3,7 @@ version: '3.8' services: killbill: network_mode: host - image: killbill/killbill:0.22.28 + image: killbill/killbill:0.24.10 environment: - KILLBILL_CATALOG_URI=SpyCarAdvanced.xml - KILLBILL_DAO_URL=jdbc:mysql://127.0.0.1:3306/killbill @@ -22,6 +22,6 @@ services: - db db: network_mode: host - image: killbill/mariadb:0.22 + image: killbill/mariadb:0.24 environment: - MYSQL_ROOT_PASSWORD=root From f66ea569eb174d1818aba10de31383b73564c744 Mon Sep 17 00:00:00 2001 From: xsalefter Date: Sun, 7 Apr 2024 02:12:28 +0700 Subject: [PATCH 3/4] update kbswagger.yaml from latest killbill version --- codegen/kbswagger.yaml | 23668 +++++++++++++++++++-------------------- 1 file changed, 11834 insertions(+), 11834 deletions(-) diff --git a/codegen/kbswagger.yaml b/codegen/kbswagger.yaml index 9961efb..60605b6 100644 --- a/codegen/kbswagger.yaml +++ b/codegen/kbswagger.yaml @@ -2,7 +2,7 @@ swagger: "2.0" info: description: "Kill Bill is an open-source billing and payments platform" - version: "0.24.0" + version: "0.24.10" title: "Kill Bill" contact: name: "killbilling-users@googlegroups.com" @@ -10,1680 +10,1768 @@ info: name: "Apache License, Version 2.0" url: "http://www.apache.org/licenses/LICENSE-2.0.html" tags: -- name: "Account" -- name: "Admin" -- name: "Bundle" -- name: "Catalog" -- name: "Credit" -- name: "CustomField" -- name: "Export" -- name: "InvoiceItem" -- name: "InvoicePayment" -- name: "Invoice" -- name: "NodesInfo" -- name: "Overdue" -- name: "PaymentGateway" -- name: "PaymentMethod" -- name: "Payment" -- name: "PluginInfo" -- name: "Security" -- name: "Subscription" -- name: "TagDefinition" -- name: "Tag" -- name: "Tenant" -- name: "PaymentTransaction" -- name: "Usage" + - name: "Account" + - name: "Admin" + - name: "Bundle" + - name: "Catalog" + - name: "Credit" + - name: "CustomField" + - name: "Export" + - name: "InvoiceItem" + - name: "InvoicePayment" + - name: "Invoice" + - name: "NodesInfo" + - name: "Overdue" + - name: "PaymentGateway" + - name: "PaymentMethod" + - name: "Payment" + - name: "PluginInfo" + - name: "Security" + - name: "Subscription" + - name: "TagDefinition" + - name: "Tag" + - name: "Tenant" + - name: "PaymentTransaction" + - name: "Usage" paths: - /1.0/kb/accounts/{accountId}/cbaRebalancing: - put: + /1.0/kb/accounts/{accountId}/tags: + get: tags: - - "Account" - summary: "Rebalance account CBA" + - "Account" + summary: "Retrieve account tags" description: "" - operationId: "rebalanceExistingCBAOnAccount" - consumes: - - "application/json" + operationId: "getAccountTags" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "includedDeleted" + in: "query" + required: false + type: "boolean" + default: false + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: - "204": - description: "Successful operation" + "200": + description: "successful operation" + schema: + type: "array" + items: + $ref: "#/definitions/Tag" "400": description: "Invalid account id supplied" + "404": + description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/invoices/pagination: - get: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + post: tags: - - "Account" - summary: "Retrieve paginated invoices for account" + - "Account" + summary: "Add tags to account" description: "" - operationId: "getInvoicesForAccountPaginated" + operationId: "createAccountTags" + consumes: + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "offset" - in: "query" - required: false - type: "integer" - default: 0 - format: "int64" - - name: "limit" - in: "query" - required: false - type: "integer" - default: 100 - format: "int64" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + type: "array" + items: + type: "string" + format: "uuid" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: - "200": - description: "successful operation" + "201": + description: "Tag created successfully" schema: type: "array" items: - $ref: "#/definitions/Invoice" + $ref: "#/definitions/Tag" "400": description: "Invalid account id supplied" - "404": - description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/paymentMethods: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + delete: + tags: + - "Account" + summary: "Remove tags from account" + description: "" + operationId: "deleteAccountTags" + consumes: + - "application/json" + produces: + - "application/json" + parameters: + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "tagDef" + in: "query" + required: false + type: "array" + items: + type: "string" + format: "uuid" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "204": + description: "Successful operation" + "400": + description: "Invalid account id supplied or account does not have a default\ + \ payment method (AUTO_PAY_OFF tag only)" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/accounts/{accountId}/emails: get: tags: - - "Account" - summary: "Retrieve account payment methods" + - "Account" + summary: "Retrieve an account emails" description: "" - operationId: "getPaymentMethodsForAccount" + operationId: "getEmails" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "withPluginInfo" - in: "query" - required: false - type: "boolean" - default: false - - name: "includedDeleted" - in: "query" - required: false - type: "boolean" - default: false - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "accountId" + in: "path" + required: true type: "string" - collectionFormat: "multi" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" responses: "200": description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/PaymentMethod" + $ref: "#/definitions/AccountEmail" "400": description: "Invalid account id supplied" - "404": - description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] post: tags: - - "Account" - summary: "Add a payment method" + - "Account" + summary: "Add account email" description: "" - operationId: "createPaymentMethod" + operationId: "addEmail" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/PaymentMethod" - - name: "isDefault" - in: "query" - required: false - type: "boolean" - default: false - - name: "payAllUnpaidInvoices" - in: "query" - required: false - type: "boolean" - default: false - - name: "controlPluginName" - in: "query" - required: false - type: "array" - items: + - name: "accountId" + in: "path" + required: true type: "string" - collectionFormat: "multi" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/AccountEmail" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "201": - description: "Payment method created" + description: "Email created successfully" schema: - $ref: "#/definitions/PaymentMethod" + type: "array" + items: + $ref: "#/definitions/AccountEmail" "400": description: "Invalid account id supplied" "404": description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/accounts/payments: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/accounts/{accountId}/emails/{email}: + delete: + tags: + - "Account" + summary: "Delete email from account" + description: "" + operationId: "removeEmail" + produces: + - "application/json" + parameters: + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "email" + in: "path" + required: true + type: "string" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "204": + description: "Successful operation" + "400": + description: "Invalid account id supplied" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/accounts: + get: + tags: + - "Account" + summary: "Retrieve an account by external key" + description: "" + operationId: "getAccountByKey" + produces: + - "application/json" + parameters: + - name: "externalKey" + in: "query" + required: true + type: "string" + - name: "accountWithBalance" + in: "query" + required: false + type: "boolean" + default: false + - name: "accountWithBalanceAndCBA" + in: "query" + required: false + type: "boolean" + default: false + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" + responses: + "200": + description: "successful operation" + schema: + $ref: "#/definitions/Account" + "404": + description: "Account not found" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] post: tags: - - "Account" - summary: "Trigger a payment using the account external key (authorization, purchase\ - \ or credit)" + - "Account" + summary: "Create account" description: "" - operationId: "processPaymentByExternalKey" + operationId: "createAccount" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/PaymentTransaction" - - name: "externalKey" - in: "query" - required: true - type: "string" - - name: "paymentMethodId" - in: "query" - required: false - type: "string" - format: "uuid" - - name: "controlPluginName" - in: "query" - required: false - type: "array" - items: + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/Account" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true type: "string" - collectionFormat: "multi" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "201": - description: "Payment transaction created successfully" + description: "Account created successfully" schema: - $ref: "#/definitions/Payment" + $ref: "#/definitions/Account" "400": - description: "Invalid account external key supplied" - "404": - description: "Account not found" - "402": - description: "Transaction declined by gateway" - "422": - description: "Payment is aborted by a control plugin" - "502": - description: "Failed to submit payment transaction" - "503": - description: "Payment in unknown status, failed to receive gateway response" - "504": - description: "Payment operation timeout" + description: "Invalid account data supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/accounts/block/{blockingId}/auditLogsWithHistory: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/accounts/search/{searchKey}: get: tags: - - "Account" - summary: "Retrieve blocking state audit logs with history by id" + - "Account" + summary: "Search accounts" description: "" - operationId: "getBlockingStateAuditLogsWithHistory" + operationId: "searchAccounts" produces: - - "application/json" - parameters: - - name: "blockingId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" + - "application/json" + parameters: + - name: "searchKey" + in: "path" + required: true + type: "string" + pattern: ".*" + - name: "offset" + in: "query" + required: false + type: "integer" + default: 0 + format: "int64" + - name: "limit" + in: "query" + required: false + type: "integer" + default: 100 + format: "int64" + - name: "accountWithBalance" + in: "query" + required: false + type: "boolean" + default: false + - name: "accountWithBalanceAndCBA" + in: "query" + required: false + type: "boolean" + default: false + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/AuditLog" - "404": - description: "Blocking state not found" + $ref: "#/definitions/Account" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/emails/{accountEmailId}/auditLogsWithHistory: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/accounts/pagination: get: tags: - - "Account" - summary: "Retrieve account email audit logs with history by id" + - "Account" + summary: "List accounts" description: "" - operationId: "getAccountEmailAuditLogsWithHistory" + operationId: "getAccounts" produces: - - "application/json" - parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "accountEmailId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" + - "application/json" + parameters: + - name: "offset" + in: "query" + required: false + type: "integer" + default: 0 + format: "int64" + - name: "limit" + in: "query" + required: false + type: "integer" + default: 100 + format: "int64" + - name: "accountWithBalance" + in: "query" + required: false + type: "boolean" + default: false + - name: "accountWithBalanceAndCBA" + in: "query" + required: false + type: "boolean" + default: false + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/AuditLog" - "404": - description: "Account not found" + $ref: "#/definitions/Account" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/auditLogsWithHistory: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/accounts/{accountId}: get: tags: - - "Account" - summary: "Retrieve account audit logs with history by account id" + - "Account" + summary: "Retrieve an account by id" description: "" - operationId: "getAccountAuditLogsWithHistory" + operationId: "getAccount" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "accountWithBalance" + in: "query" + required: false + type: "boolean" + default: false + - name: "accountWithBalanceAndCBA" + in: "query" + required: false + type: "boolean" + default: false + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" schema: - type: "array" - items: - $ref: "#/definitions/AuditLog" + $ref: "#/definitions/Account" + "400": + description: "Invalid account id supplied" "404": description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/accounts/{childAccountId}/transferCredit: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] put: tags: - - "Account" - summary: "Move a given child credit to the parent level" + - "Account" + summary: "Update account" description: "" - operationId: "transferChildCreditToParent" + operationId: "updateAccount" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "childAccountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/Account" + - name: "treatNullAsReset" + in: "query" + required: false + type: "boolean" + default: false + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "204": description: "Successful operation" "400": - description: "Account does not have credit" - "404": - description: "Account not found" + description: "Invalid account data supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/tags: - get: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + delete: tags: - - "Account" - summary: "Retrieve account tags" + - "Account" + summary: "Close account" description: "" - operationId: "getAccountTags" + operationId: "closeAccount" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "includedDeleted" - in: "query" - required: false - type: "boolean" - default: false - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "cancelAllSubscriptions" + in: "query" + required: false + type: "boolean" + default: false + - name: "writeOffUnpaidInvoices" + in: "query" + required: false + type: "boolean" + default: false + - name: "itemAdjustUnpaidInvoices" + in: "query" + required: false + type: "boolean" + default: false + - name: "removeFutureNotifications" + in: "query" + required: false + type: "boolean" + default: true + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: - "200": - description: "successful operation" - schema: - type: "array" - items: - $ref: "#/definitions/Tag" + "204": + description: "Successful operation" "400": description: "Invalid account id supplied" - "404": - description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - post: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/accounts/{accountId}/children: + get: tags: - - "Account" - summary: "Add tags to account" + - "Account" + summary: "List children accounts" description: "" - operationId: "createAccountTags" - consumes: - - "application/json" + operationId: "getChildrenAccounts" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - type: "array" - items: - type: "string" - format: "uuid" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "accountWithBalance" + in: "query" + required: false + type: "boolean" + default: false + - name: "accountWithBalanceAndCBA" + in: "query" + required: false + type: "boolean" + default: false + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: - "201": - description: "Tag created successfully" + "200": + description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/Tag" + $ref: "#/definitions/Account" "400": - description: "Invalid account id supplied" + description: "Invalid parent account id supplied" + "404": + description: "Parent Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - delete: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/accounts/{childAccountId}/transferCredit: + put: tags: - - "Account" - summary: "Remove tags from account" + - "Account" + summary: "Move a given child credit to the parent level" description: "" - operationId: "deleteAccountTags" + operationId: "transferChildCreditToParent" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "tagDef" - in: "query" - required: false - type: "array" - items: + - name: "childAccountId" + in: "path" + required: true type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "204": description: "Successful operation" "400": - description: "Invalid account id supplied or account does not have a default\ - \ payment method (AUTO_PAY_OFF tag only)" + description: "Account does not have credit" + "404": + description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/bundles: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/accounts/{accountId}/block: get: tags: - - "Account" - summary: "Retrieve bundles for account" + - "Account" + summary: "Retrieve blocking states for account" description: "" - operationId: "getAccountBundles" + operationId: "getBlockingStates" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "externalKey" - in: "query" - required: false - type: "string" - - name: "bundlesFilter" - in: "query" - required: false - type: "string" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "blockingStateTypes" + in: "query" + required: false + type: "array" + items: + type: "string" + enum: + - "SUBSCRIPTION" + - "SUBSCRIPTION_BUNDLE" + - "ACCOUNT" + collectionFormat: "multi" + - name: "blockingStateSvcs" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/Bundle" + $ref: "#/definitions/BlockingState" "400": description: "Invalid account id supplied" - "404": - description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/bundles/pagination: - get: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + post: tags: - - "Account" - summary: "Retrieve paginated bundles for account" + - "Account" + summary: "Block an account" description: "" - operationId: "getAccountBundlesPaginated" - produces: - - "application/json" + operationId: "addAccountBlockingState" + consumes: + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "offset" - in: "query" - required: false - type: "integer" - default: 0 - format: "int64" - - name: "limit" - in: "query" - required: false - type: "integer" - default: 100 - format: "int64" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/BlockingState" + - name: "requestedDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: - "200": - description: "successful operation" + "201": + description: "Blocking state created successfully" schema: type: "array" items: - $ref: "#/definitions/Bundle" + $ref: "#/definitions/BlockingState" "400": description: "Invalid account id supplied" "404": description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/accounts/{accountId}/invoicePayments: get: tags: - - "Account" - summary: "Retrieve an account by id" + - "Account" + summary: "Retrieve account invoice payments" description: "" - operationId: "getAccount" + operationId: "getInvoicePayments" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "accountWithBalance" - in: "query" - required: false - type: "boolean" - default: false - - name: "accountWithBalanceAndCBA" - in: "query" - required: false - type: "boolean" - default: false - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "withPluginInfo" + in: "query" + required: false + type: "boolean" + default: false + - name: "withAttempts" + in: "query" + required: false + type: "boolean" + default: false + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" schema: - $ref: "#/definitions/Account" + type: "array" + items: + $ref: "#/definitions/InvoicePayment" "400": description: "Invalid account id supplied" "404": description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - put: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + post: tags: - - "Account" - summary: "Update account" + - "Account" + summary: "Trigger a payment for all unpaid invoices" description: "" - operationId: "updateAccount" + operationId: "payAllInvoices" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/Account" - - name: "treatNullAsReset" - in: "query" - required: false - type: "boolean" - default: false - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "paymentMethodId" + in: "query" + required: false + type: "string" + format: "uuid" + - name: "externalPayment" + in: "query" + required: false + type: "boolean" + default: false + - name: "paymentAmount" + in: "query" + required: false + type: "number" + - name: "targetDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: - "204": + "201": description: "Successful operation" - "400": - description: "Invalid account data supplied" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - delete: - tags: - - "Account" - summary: "Close account" - description: "" - operationId: "closeAccount" - produces: - - "application/json" - parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "cancelAllSubscriptions" - in: "query" - required: false - type: "boolean" - default: false - - name: "writeOffUnpaidInvoices" - in: "query" - required: false - type: "boolean" - default: false - - name: "itemAdjustUnpaidInvoices" - in: "query" - required: false - type: "boolean" - default: false - - name: "removeFutureNotifications" - in: "query" - required: false - type: "boolean" - default: true - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: + schema: + type: "array" + items: + $ref: "#/definitions/Invoice" "204": - description: "Successful operation" - "400": + description: "Nothing to pay" + "404": description: "Invalid account id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/invoices: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/accounts/{accountId}/customFields: get: tags: - - "Account" - summary: "Retrieve account invoices" + - "Account" + summary: "Retrieve account custom fields" description: "" - operationId: "getInvoicesForAccount" + operationId: "getAccountCustomFields" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "startDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "endDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "withMigrationInvoices" - in: "query" - required: false - type: "boolean" - default: false - - name: "unpaidInvoicesOnly" - in: "query" - required: false - type: "boolean" - default: false - - name: "includeVoidedInvoices" - in: "query" - required: false - type: "boolean" - default: false - - name: "includeInvoiceComponents" - in: "query" - required: false - type: "boolean" - default: false - - name: "invoicesFilter" - in: "query" - required: false - type: "string" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/Invoice" + $ref: "#/definitions/CustomField" "400": description: "Invalid account id supplied" - "404": - description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/invoicePayments: - get: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + post: tags: - - "Account" - summary: "Retrieve account invoice payments" + - "Account" + summary: "Add custom fields to account" description: "" - operationId: "getInvoicePayments" + operationId: "createAccountCustomFields" + consumes: + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "withPluginInfo" - in: "query" - required: false - type: "boolean" - default: false - - name: "withAttempts" - in: "query" - required: false - type: "boolean" - default: false - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + type: "array" + items: + $ref: "#/definitions/CustomField" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" responses: - "200": - description: "successful operation" + "201": + description: "Custom field created successfully" schema: type: "array" items: - $ref: "#/definitions/InvoicePayment" + $ref: "#/definitions/CustomField" "400": description: "Invalid account id supplied" - "404": - description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - post: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + put: tags: - - "Account" - summary: "Trigger a payment for all unpaid invoices" + - "Account" + summary: "Modify custom fields to account" description: "" - operationId: "payAllInvoices" + operationId: "modifyAccountCustomFields" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "paymentMethodId" - in: "query" - required: false - type: "string" - format: "uuid" - - name: "externalPayment" - in: "query" - required: false - type: "boolean" - default: false - - name: "paymentAmount" - in: "query" - required: false - type: "number" - - name: "targetDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "accountId" + in: "path" + required: true type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "201": - description: "Successful operation" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true schema: type: "array" items: - $ref: "#/definitions/Invoice" + $ref: "#/definitions/CustomField" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: "204": - description: "Nothing to pay" - "404": + description: "Successful operation" + "400": description: "Invalid account id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/payments: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + delete: + tags: + - "Account" + summary: "Remove custom fields from account" + description: "" + operationId: "deleteAccountCustomFields" + consumes: + - "application/json" + produces: + - "application/json" + parameters: + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "customField" + in: "query" + required: false + type: "array" + items: + type: "string" + format: "uuid" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "204": + description: "Successful operation" + "400": + description: "Invalid account id supplied" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/accounts/{accountId}/auditLogs: get: tags: - - "Account" - summary: "Retrieve account payments" + - "Account" + summary: "Retrieve audit logs by account id" description: "" - operationId: "getPaymentsForAccount" + operationId: "getAccountAuditLogs" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "withAttempts" - in: "query" - required: false - type: "boolean" - default: false - - name: "withPluginInfo" - in: "query" - required: false - type: "boolean" - default: false - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "accountId" + in: "path" + required: true type: "string" - collectionFormat: "multi" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" responses: "200": description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/Payment" - "400": - description: "Invalid account id supplied" + $ref: "#/definitions/AuditLog" + "404": + description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - post: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/accounts/{accountId}/paymentMethods/{paymentMethodId}/setDefault: + put: tags: - - "Account" - summary: "Trigger a payment (authorization, purchase or credit)" + - "Account" + summary: "Set the default payment method" description: "" - operationId: "processPayment" + operationId: "setDefaultPaymentMethod" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/PaymentTransaction" - - name: "paymentMethodId" - in: "query" - required: false - type: "string" - format: "uuid" - - name: "controlPluginName" - in: "query" - required: false - type: "array" - items: + - name: "accountId" + in: "path" + required: true type: "string" - collectionFormat: "multi" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "paymentMethodId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "payAllUnpaidInvoices" + in: "query" + required: false + type: "boolean" + default: false + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: - "201": - description: "Payment transaction created successfully" - schema: - $ref: "#/definitions/Payment" + "204": + description: "Successful operation" "400": - description: "Invalid account id supplied" + description: "Invalid account id or payment method id supplied" "404": description: "Account not found" - "402": - description: "Transaction declined by gateway" - "422": - description: "Payment is aborted by a control plugin" - "502": - description: "Failed to submit payment transaction" - "503": - description: "Payment in unknown status, failed to receive gateway response" - "504": - description: "Payment operation timeout" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/overdue: - get: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/accounts/{accountId}/paymentMethods/refresh: + put: tags: - - "Account" - summary: "Retrieve overdue state for account" + - "Account" + summary: "Refresh account payment methods" description: "" - operationId: "getOverdueAccount" + operationId: "refreshPaymentMethods" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "pluginName" + in: "query" + required: false + type: "string" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: - "200": - description: "successful operation" - schema: - $ref: "#/definitions/OverdueState" + "204": + description: "Successful operation" "400": description: "Invalid account id supplied" "404": description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/block: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/accounts/{accountId}/paymentMethods: get: tags: - - "Account" - summary: "Retrieve blocking states for account" + - "Account" + summary: "Retrieve account payment methods" description: "" - operationId: "getBlockingStates" + operationId: "getPaymentMethodsForAccount" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "blockingStateTypes" - in: "query" - required: false - type: "array" - items: + - name: "accountId" + in: "path" + required: true type: "string" - enum: - - "SUBSCRIPTION" - - "SUBSCRIPTION_BUNDLE" - - "ACCOUNT" - collectionFormat: "multi" - - name: "blockingStateSvcs" - in: "query" - required: false - type: "array" - items: + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "withPluginInfo" + in: "query" + required: false + type: "boolean" + default: false + - name: "includedDeleted" + in: "query" + required: false + type: "boolean" + default: false + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "audit" + in: "query" + required: false type: "string" - collectionFormat: "multi" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/BlockingState" + $ref: "#/definitions/PaymentMethod" "400": description: "Invalid account id supplied" + "404": + description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] post: tags: - - "Account" - summary: "Block an account" + - "Account" + summary: "Add a payment method" description: "" - operationId: "addAccountBlockingState" + operationId: "createPaymentMethod" consumes: - - "application/json" + - "application/json" + produces: + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/BlockingState" - - name: "requestedDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/PaymentMethod" + - name: "isDefault" + in: "query" + required: false + type: "boolean" + default: false + - name: "payAllUnpaidInvoices" + in: "query" + required: false + type: "boolean" + default: false + - name: "controlPluginName" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "201": - description: "Blocking state created successfully" + description: "Payment method created" schema: - type: "array" - items: - $ref: "#/definitions/BlockingState" + $ref: "#/definitions/PaymentMethod" "400": description: "Invalid account id supplied" "404": description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/allCustomFields: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/accounts/{accountId}/auditLogsWithHistory: get: tags: - - "Account" - summary: "Retrieve account customFields" + - "Account" + summary: "Retrieve account audit logs with history by account id" description: "" - operationId: "getAllCustomFields" + operationId: "getAccountAuditLogsWithHistory" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "objectType" - in: "query" - required: false - type: "string" - enum: - - "ACCOUNT" - - "ACCOUNT_EMAIL" - - "BLOCKING_STATES" - - "BUNDLE" - - "CUSTOM_FIELD" - - "INVOICE" - - "PAYMENT" - - "TRANSACTION" - - "INVOICE_ITEM" - - "INVOICE_PAYMENT" - - "SUBSCRIPTION" - - "SUBSCRIPTION_EVENT" - - "SERVICE_BROADCAST" - - "PAYMENT_ATTEMPT" - - "PAYMENT_METHOD" - - "TAG" - - "TAG_DEFINITION" - - "TENANT" - - "TENANT_KVS" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" responses: "200": description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/CustomField" - "400": - description: "Invalid account id supplied" + $ref: "#/definitions/AuditLog" "404": description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/customFields: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/accounts/{accountId}/bundles: get: tags: - - "Account" - summary: "Retrieve account custom fields" + - "Account" + summary: "Retrieve bundles for account" description: "" - operationId: "getAccountCustomFields" + operationId: "getAccountBundles" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "externalKey" + in: "query" + required: false + type: "string" + - name: "bundlesFilter" + in: "query" + required: false + type: "string" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/CustomField" + $ref: "#/definitions/Bundle" "400": description: "Invalid account id supplied" + "404": + description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - post: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/accounts/{accountId}/bundles/pagination: + get: tags: - - "Account" - summary: "Add custom fields to account" + - "Account" + summary: "Retrieve paginated bundles for account" description: "" - operationId: "createAccountCustomFields" - consumes: - - "application/json" + operationId: "getAccountBundlesPaginated" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - type: "array" - items: - $ref: "#/definitions/CustomField" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "offset" + in: "query" + required: false + type: "integer" + default: 0 + format: "int64" + - name: "limit" + in: "query" + required: false + type: "integer" + default: 100 + format: "int64" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: - "201": - description: "Custom field created successfully" + "200": + description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/CustomField" + $ref: "#/definitions/Bundle" "400": description: "Invalid account id supplied" + "404": + description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - put: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/accounts/{accountId}/emails/{accountEmailId}/auditLogsWithHistory: + get: tags: - - "Account" - summary: "Modify custom fields to account" + - "Account" + summary: "Retrieve account email audit logs with history by id" description: "" - operationId: "modifyAccountCustomFields" - consumes: - - "application/json" + operationId: "getAccountEmailAuditLogsWithHistory" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - type: "array" - items: - $ref: "#/definitions/CustomField" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "accountEmailId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" responses: - "204": - description: "Successful operation" - "400": - description: "Invalid account id supplied" + "200": + description: "successful operation" + schema: + type: "array" + items: + $ref: "#/definitions/AuditLog" + "404": + description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - delete: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/accounts/{accountId}/timeline: + get: tags: - - "Account" - summary: "Remove custom fields from account" + - "Account" + summary: "Retrieve account timeline" description: "" - operationId: "deleteAccountCustomFields" - consumes: - - "application/json" + operationId: "getAccountTimeline" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "customField" - in: "query" - required: false - type: "array" - items: + - name: "accountId" + in: "path" + required: true type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "parallel" + in: "query" + required: false + type: "boolean" + default: false + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: - "204": - description: "Successful operation" + "200": + description: "successful operation" + schema: + $ref: "#/definitions/AccountTimeline" "400": description: "Invalid account id supplied" + "404": + description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/timeline: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/accounts/{accountId}/allCustomFields: get: tags: - - "Account" - summary: "Retrieve account timeline" + - "Account" + summary: "Retrieve account customFields" description: "" - operationId: "getAccountTimeline" + operationId: "getAllCustomFields" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "parallel" - in: "query" - required: false - type: "boolean" - default: false - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "objectType" + in: "query" + required: false + type: "string" + enum: + - "ACCOUNT" + - "ACCOUNT_EMAIL" + - "BLOCKING_STATES" + - "BUNDLE" + - "CUSTOM_FIELD" + - "INVOICE" + - "PAYMENT" + - "TRANSACTION" + - "INVOICE_ITEM" + - "INVOICE_PAYMENT" + - "SUBSCRIPTION" + - "SUBSCRIPTION_EVENT" + - "SERVICE_BROADCAST" + - "PAYMENT_ATTEMPT" + - "PAYMENT_METHOD" + - "TAG" + - "TAG_DEFINITION" + - "TENANT" + - "TENANT_KVS" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" schema: - $ref: "#/definitions/AccountTimeline" + type: "array" + items: + $ref: "#/definitions/CustomField" "400": description: "Invalid account id supplied" "404": description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/paymentMethods/refresh: - put: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/accounts/{accountId}/allTags: + get: tags: - - "Account" - summary: "Refresh account payment methods" + - "Account" + summary: "Retrieve account tags" description: "" - operationId: "refreshPaymentMethods" + operationId: "getAllTags" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "pluginName" - in: "query" - required: false - type: "string" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "accountId" + in: "path" + required: true type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "objectType" + in: "query" + required: false + type: "string" + enum: + - "ACCOUNT" + - "ACCOUNT_EMAIL" + - "BLOCKING_STATES" + - "BUNDLE" + - "CUSTOM_FIELD" + - "INVOICE" + - "PAYMENT" + - "TRANSACTION" + - "INVOICE_ITEM" + - "INVOICE_PAYMENT" + - "SUBSCRIPTION" + - "SUBSCRIPTION_EVENT" + - "SERVICE_BROADCAST" + - "PAYMENT_ATTEMPT" + - "PAYMENT_METHOD" + - "TAG" + - "TAG_DEFINITION" + - "TENANT" + - "TENANT_KVS" + - name: "includedDeleted" + in: "query" + required: false + type: "boolean" + default: false + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: - "204": - description: "Successful operation" + "200": + description: "successful operation" + schema: + type: "array" + items: + $ref: "#/definitions/Tag" "400": description: "Invalid account id supplied" "404": description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/auditLogs: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/accounts/block/{blockingId}/auditLogsWithHistory: get: tags: - - "Account" - summary: "Retrieve audit logs by account id" + - "Account" + summary: "Retrieve blocking state audit logs with history by id" description: "" - operationId: "getAccountAuditLogs" + operationId: "getBlockingStateAuditLogsWithHistory" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" + - name: "blockingId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" responses: "200": description: "successful operation" @@ -1692,651 +1780,496 @@ paths: items: $ref: "#/definitions/AuditLog" "404": - description: "Account not found" + description: "Blocking state not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/accounts: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/accounts/{accountId}/invoices: get: tags: - - "Account" - summary: "Retrieve an account by external key" + - "Account" + summary: "Retrieve account invoices" description: "" - operationId: "getAccountByKey" + operationId: "getInvoicesForAccount" produces: - - "application/json" + - "application/json" parameters: - - name: "externalKey" - in: "query" - required: true - type: "string" - - name: "accountWithBalance" - in: "query" - required: false - type: "boolean" - default: false - - name: "accountWithBalanceAndCBA" - in: "query" - required: false - type: "boolean" - default: false - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "startDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "endDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "withMigrationInvoices" + in: "query" + required: false + type: "boolean" + default: false + - name: "unpaidInvoicesOnly" + in: "query" + required: false + type: "boolean" + default: false + - name: "includeVoidedInvoices" + in: "query" + required: false + type: "boolean" + default: false + - name: "includeInvoiceComponents" + in: "query" + required: false + type: "boolean" + default: false + - name: "invoicesFilter" + in: "query" + required: false + type: "string" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" schema: - $ref: "#/definitions/Account" + type: "array" + items: + $ref: "#/definitions/Invoice" + "400": + description: "Invalid account id supplied" "404": description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - post: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/accounts/{accountId}/invoices/pagination: + get: tags: - - "Account" - summary: "Create account" + - "Account" + summary: "Retrieve paginated invoices for account" description: "" - operationId: "createAccount" - consumes: - - "application/json" + operationId: "getInvoicesForAccountPaginated" produces: - - "application/json" + - "application/json" parameters: - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/Account" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "offset" + in: "query" + required: false + type: "integer" + default: 0 + format: "int64" + - name: "limit" + in: "query" + required: false + type: "integer" + default: 100 + format: "int64" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: - "201": - description: "Account created successfully" + "200": + description: "successful operation" schema: - $ref: "#/definitions/Account" + type: "array" + items: + $ref: "#/definitions/Invoice" "400": - description: "Invalid account data supplied" + description: "Invalid account id supplied" + "404": + description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/accounts/search/{searchKey}: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/accounts/{accountId}/overdue: get: tags: - - "Account" - summary: "Search accounts" + - "Account" + summary: "Retrieve overdue state for account" description: "" - operationId: "searchAccounts" + operationId: "getOverdueAccount" produces: - - "application/json" + - "application/json" parameters: - - name: "searchKey" - in: "path" - required: true - type: "string" - pattern: ".*" - - name: "offset" - in: "query" - required: false - type: "integer" - default: 0 - format: "int64" - - name: "limit" - in: "query" - required: false - type: "integer" - default: 100 - format: "int64" - - name: "accountWithBalance" - in: "query" - required: false - type: "boolean" - default: false - - name: "accountWithBalanceAndCBA" - in: "query" - required: false - type: "boolean" - default: false - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" responses: "200": description: "successful operation" schema: - type: "array" - items: - $ref: "#/definitions/Account" + $ref: "#/definitions/OverdueState" + "400": + description: "Invalid account id supplied" + "404": + description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/accounts/pagination: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/accounts/{accountId}/payments: get: tags: - - "Account" - summary: "List accounts" + - "Account" + summary: "Retrieve account payments" description: "" - operationId: "getAccounts" + operationId: "getPaymentsForAccount" produces: - - "application/json" + - "application/json" parameters: - - name: "offset" - in: "query" - required: false - type: "integer" - default: 0 - format: "int64" - - name: "limit" - in: "query" - required: false - type: "integer" - default: 100 - format: "int64" - - name: "accountWithBalance" - in: "query" - required: false - type: "boolean" - default: false - - name: "accountWithBalanceAndCBA" - in: "query" - required: false - type: "boolean" - default: false - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "withAttempts" + in: "query" + required: false + type: "boolean" + default: false + - name: "withPluginInfo" + in: "query" + required: false + type: "boolean" + default: false + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/Account" + $ref: "#/definitions/Payment" + "400": + description: "Invalid account id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/emails/{email}: - delete: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + post: tags: - - "Account" - summary: "Delete email from account" + - "Account" + summary: "Trigger a payment (authorization, purchase or credit)" description: "" - operationId: "removeEmail" - produces: - - "application/json" - parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "email" - in: "path" - required: true - type: "string" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "204": - description: "Successful operation" - "400": - description: "Invalid account id supplied" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/children: - get: - tags: - - "Account" - summary: "List children accounts" - description: "" - operationId: "getChildrenAccounts" - produces: - - "application/json" - parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "accountWithBalance" - in: "query" - required: false - type: "boolean" - default: false - - name: "accountWithBalanceAndCBA" - in: "query" - required: false - type: "boolean" - default: false - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" - responses: - "200": - description: "successful operation" - schema: - type: "array" - items: - $ref: "#/definitions/Account" - "400": - description: "Invalid parent account id supplied" - "404": - description: "Parent Account not found" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/paymentMethods/{paymentMethodId}/setDefault: - put: - tags: - - "Account" - summary: "Set the default payment method" - description: "" - operationId: "setDefaultPaymentMethod" + operationId: "processPayment" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "paymentMethodId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "payAllUnpaidInvoices" - in: "query" - required: false - type: "boolean" - default: false - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/PaymentTransaction" + - name: "paymentMethodId" + in: "query" + required: false + type: "string" + format: "uuid" + - name: "controlPluginName" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "204": - description: "Successful operation" - "400": - description: "Invalid account id or payment method id supplied" - "404": - description: "Account not found" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/emails: - get: - tags: - - "Account" - summary: "Retrieve an account emails" - description: "" - operationId: "getEmails" - produces: - - "application/json" - parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" responses: - "200": - description: "successful operation" + "201": + description: "Payment transaction created successfully" schema: - type: "array" - items: - $ref: "#/definitions/AccountEmail" + $ref: "#/definitions/Payment" "400": description: "Invalid account id supplied" + "404": + description: "Account not found" + "402": + description: "Transaction declined by gateway" + "422": + description: "Payment is aborted by a control plugin" + "502": + description: "Failed to submit payment transaction" + "503": + description: "Payment in unknown status, failed to receive gateway response" + "504": + description: "Payment operation timeout" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/accounts/payments: post: tags: - - "Account" - summary: "Add account email" + - "Account" + summary: "Trigger a payment using the account external key (authorization, purchase\ + \ or credit)" description: "" - operationId: "addEmail" + operationId: "processPaymentByExternalKey" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/AccountEmail" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/PaymentTransaction" + - name: "externalKey" + in: "query" + required: true + type: "string" + - name: "paymentMethodId" + in: "query" + required: false + type: "string" + format: "uuid" + - name: "controlPluginName" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "201": - description: "Email created successfully" + description: "Payment transaction created successfully" schema: - type: "array" - items: - $ref: "#/definitions/AccountEmail" + $ref: "#/definitions/Payment" "400": - description: "Invalid account id supplied" + description: "Invalid account external key supplied" "404": description: "Account not found" + "402": + description: "Transaction declined by gateway" + "422": + description: "Payment is aborted by a control plugin" + "502": + description: "Failed to submit payment transaction" + "503": + description: "Payment in unknown status, failed to receive gateway response" + "504": + description: "Payment operation timeout" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/allTags: - get: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/accounts/{accountId}/cbaRebalancing: + put: tags: - - "Account" - summary: "Retrieve account tags" + - "Account" + summary: "Rebalance account CBA" description: "" - operationId: "getAllTags" + operationId: "rebalanceExistingCBAOnAccount" + consumes: + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "objectType" - in: "query" - required: false - type: "string" - enum: - - "ACCOUNT" - - "ACCOUNT_EMAIL" - - "BLOCKING_STATES" - - "BUNDLE" - - "CUSTOM_FIELD" - - "INVOICE" - - "PAYMENT" - - "TRANSACTION" - - "INVOICE_ITEM" - - "INVOICE_PAYMENT" - - "SUBSCRIPTION" - - "SUBSCRIPTION_EVENT" - - "SERVICE_BROADCAST" - - "PAYMENT_ATTEMPT" - - "PAYMENT_METHOD" - - "TAG" - - "TAG_DEFINITION" - - "TENANT" - - "TENANT_KVS" - - name: "includedDeleted" - in: "query" - required: false - type: "boolean" - default: false - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: - "200": - description: "successful operation" - schema: - type: "array" - items: - $ref: "#/definitions/Tag" + "204": + description: "Successful operation" "400": description: "Invalid account id supplied" - "404": - description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/admin/invoices: - post: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/admin/healthcheck: + put: tags: - - "Admin" - summary: "Trigger an invoice generation for all parked accounts" + - "Admin" + summary: "Put the host back into rotation" description: "" - operationId: "triggerInvoiceGenerationForParkedAccounts" - consumes: - - "application/json" + operationId: "putInRotation" produces: - - "application/json" - parameters: - - name: "offset" - in: "query" - required: false - type: "integer" - default: 0 - format: "int64" - - name: "limit" - in: "query" - required: false - type: "integer" - default: 100 - format: "int64" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: - type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - "application/json" + parameters: [] responses: - "200": + "204": description: "Successful operation" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/admin/payments/{paymentId}/transactions/{paymentTransactionId}: - put: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + delete: tags: - - "Admin" - summary: "Update existing paymentTransaction and associated payment state" + - "Admin" + summary: "Put the host out of rotation" description: "" - operationId: "updatePaymentTransactionState" - consumes: - - "application/json" + operationId: "putOutOfRotation" produces: - - "application/json" - parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "paymentTransactionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/AdminPayment" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - "application/json" + parameters: [] responses: "204": description: "Successful operation" - "400": - description: "Invalid account data supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/admin/queues: get: tags: - - "Admin" + - "Admin" summary: "Get queues entries" description: "" operationId: "getQueueEntries" produces: - - "application/octet-stream" + - "application/octet-stream" parameters: - - name: "accountId" - in: "query" - required: false - type: "string" - format: "uuid" - - name: "queueName" - in: "query" - required: false - type: "string" - - name: "serviceName" - in: "query" - required: false - type: "string" - - name: "withHistory" - in: "query" - required: false - type: "boolean" - default: true - - name: "minDate" - in: "query" - required: false - type: "string" - - name: "maxDate" - in: "query" - required: false - type: "string" - - name: "withInProcessing" - in: "query" - required: false - type: "boolean" - default: true - - name: "withBusEvents" - in: "query" - required: false - type: "boolean" - default: true - - name: "withNotifications" - in: "query" - required: false - type: "boolean" - default: true + - name: "accountId" + in: "query" + required: false + type: "string" + format: "uuid" + - name: "queueName" + in: "query" + required: false + type: "string" + - name: "serviceName" + in: "query" + required: false + type: "string" + - name: "withHistory" + in: "query" + required: false + type: "boolean" + default: true + - name: "minDate" + in: "query" + required: false + type: "string" + - name: "maxDate" + in: "query" + required: false + type: "string" + - name: "withInProcessing" + in: "query" + required: false + type: "boolean" + default: true + - name: "withBusEvents" + in: "query" + required: false + type: "boolean" + default: true + - name: "withNotifications" + in: "query" + required: false + type: "boolean" + default: true responses: "200": description: "Success" @@ -2345,133 +2278,200 @@ paths: "404": description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/admin/cache: delete: tags: - - "Admin" + - "Admin" summary: "Invalidates the given Cache if specified, otherwise invalidates all\ \ caches" description: "" operationId: "invalidatesCache" produces: - - "application/json" + - "application/json" parameters: - - name: "cacheName" - in: "query" - required: false - type: "string" + - name: "cacheName" + in: "query" + required: false + type: "string" responses: "204": description: "Successful operation" "400": description: "Cache name does not exist or is not alive" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/admin/cache/accounts/{accountId}: delete: tags: - - "Admin" + - "Admin" summary: "Invalidates Caches per account level" description: "" operationId: "invalidatesCacheByAccount" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" responses: "204": description: "Successful operation" "400": description: "Invalid account id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/admin/cache/tenants: delete: tags: - - "Admin" + - "Admin" summary: "Invalidates Caches per tenant level" description: "" operationId: "invalidatesCacheByTenant" produces: - - "application/json" + - "application/json" parameters: [] responses: "204": description: "Successful operation" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/admin/healthcheck: - put: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/admin/invoices: + post: tags: - - "Admin" - summary: "Put the host back into rotation" + - "Admin" + summary: "Trigger an invoice generation for all parked accounts" description: "" - operationId: "putInRotation" - produces: - - "application/json" - parameters: [] + operationId: "triggerInvoiceGenerationForParkedAccounts" + consumes: + - "application/json" + produces: + - "application/json" + parameters: + - name: "offset" + in: "query" + required: false + type: "integer" + default: 0 + format: "int64" + - name: "limit" + in: "query" + required: false + type: "integer" + default: 100 + format: "int64" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: - "204": + "200": description: "Successful operation" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - delete: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/admin/payments/{paymentId}/transactions/{paymentTransactionId}: + put: tags: - - "Admin" - summary: "Put the host out of rotation" + - "Admin" + summary: "Update existing paymentTransaction and associated payment state" description: "" - operationId: "putOutOfRotation" + operationId: "updatePaymentTransactionState" + consumes: + - "application/json" produces: - - "application/json" - parameters: [] + - "application/json" + parameters: + - name: "paymentId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "paymentTransactionId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/AdminPayment" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "204": description: "Successful operation" + "400": + description: "Invalid account data supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/bundles/{bundleId}: get: tags: - - "Bundle" + - "Bundle" summary: "Retrieve a bundle by id" description: "" operationId: "getBundle" produces: - - "application/json" + - "application/json" parameters: - - name: "bundleId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "bundleId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" @@ -2482,74 +2482,74 @@ paths: "404": description: "Bundle not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] post: tags: - - "Bundle" + - "Bundle" summary: "Transfer a bundle to another account" description: "" operationId: "transferBundle" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "bundleId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/Bundle" - - name: "requestedDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "billingPolicy" - in: "query" - required: false - type: "string" - default: "END_OF_TERM" - enum: - - "START_OF_TERM" - - "END_OF_TERM" - - "IMMEDIATE" - - "ILLEGAL" - - name: "bcdTransfer" - in: "query" - required: false - type: "string" - default: "USE_EXISTING" - enum: - - "NONE" - - "USE_EXISTING" - - "ALIGN_WITH_EFF_DT" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "bundleId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/Bundle" + - name: "requestedDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "billingPolicy" + in: "query" + required: false + type: "string" + default: "END_OF_TERM" + enum: + - "START_OF_TERM" + - "END_OF_TERM" + - "IMMEDIATE" + - "ILLEGAL" + - name: "bcdTransfer" + in: "query" + required: false + type: "string" + default: "USE_EXISTING" + enum: + - "NONE" + - "USE_EXISTING" + - "ALIGN_WITH_EFF_DT" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "201": description: "Bundle transferred successfully" @@ -2560,68 +2560,39 @@ paths: "404": description: "Bundle not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/bundles/{bundleId}/auditLogsWithHistory: - get: - tags: - - "Bundle" - summary: "Retrieve bundle audit logs with history by id" - description: "" - operationId: "getBundleAuditLogsWithHistory" - produces: - - "application/json" - parameters: - - name: "bundleId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - responses: - "200": - description: "successful operation" - schema: - type: "array" - items: - $ref: "#/definitions/AuditLog" - "404": - description: "Subscription bundle not found" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/bundles/{bundleId}/tags: get: tags: - - "Bundle" + - "Bundle" summary: "Retrieve bundle tags" description: "" operationId: "getBundleTags" produces: - - "application/json" + - "application/json" parameters: - - name: "bundleId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "includedDeleted" - in: "query" - required: false - type: "boolean" - default: false - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "bundleId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "includedDeleted" + in: "query" + required: false + type: "boolean" + default: false + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" @@ -2634,46 +2605,46 @@ paths: "404": description: "Bundle not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] post: tags: - - "Bundle" + - "Bundle" summary: "Add tags to bundle" description: "" operationId: "createBundleTags" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "bundleId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - type: "array" - items: - type: "string" - format: "uuid" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "bundleId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + type: "array" + items: + type: "string" + format: "uuid" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "201": description: "Tag created successfully" @@ -2684,247 +2655,320 @@ paths: "400": description: "Invalid bundle id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] delete: tags: - - "Bundle" + - "Bundle" summary: "Remove tags from bundle" description: "" operationId: "deleteBundleTags" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "bundleId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "tagDef" - in: "query" - required: false - type: "array" - items: + - name: "bundleId" + in: "path" + required: true type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "tagDef" + in: "query" + required: false + type: "array" + items: + type: "string" + format: "uuid" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "204": description: "Successful operation" "400": description: "Invalid bundle id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/bundles: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/bundles/{bundleId}/customFields: get: tags: - - "Bundle" - summary: "Retrieve a bundle by external key" + - "Bundle" + summary: "Retrieve bundle custom fields" description: "" - operationId: "getBundleByKey" + operationId: "getBundleCustomFields" produces: - - "application/json" + - "application/json" parameters: - - name: "externalKey" - in: "query" - required: true - type: "string" - - name: "includedDeleted" - in: "query" - required: false - type: "boolean" - default: false - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "bundleId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/Bundle" - "404": - description: "Bundle not found" + $ref: "#/definitions/CustomField" + "400": + description: "Invalid bundle id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/bundles/{bundleId}/pause: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + post: + tags: + - "Bundle" + summary: "Add custom fields to bundle" + description: "" + operationId: "createBundleCustomFields" + consumes: + - "application/json" + produces: + - "application/json" + parameters: + - name: "bundleId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + type: "array" + items: + $ref: "#/definitions/CustomField" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "201": + description: "Custom field created successfully" + schema: + type: "array" + items: + $ref: "#/definitions/CustomField" + "400": + description: "Invalid bundle id supplied" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] put: tags: - - "Bundle" - summary: "Pause a bundle" + - "Bundle" + summary: "Modify custom fields to bundle" description: "" - operationId: "pauseBundle" + operationId: "modifyBundleCustomFields" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "bundleId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "requestedDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "bundleId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + type: "array" + items: + $ref: "#/definitions/CustomField" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "204": description: "Successful operation" "400": description: "Invalid bundle id supplied" - "404": - description: "Bundle not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/bundles/{bundleId}/resume: - put: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + delete: tags: - - "Bundle" - summary: "Resume a bundle" + - "Bundle" + summary: "Remove custom fields from bundle" description: "" - operationId: "resumeBundle" + operationId: "deleteBundleCustomFields" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "bundleId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "requestedDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "bundleId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "customField" + in: "query" + required: false + type: "array" + items: + type: "string" + format: "uuid" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "204": description: "Successful operation" "400": description: "Invalid bundle id supplied" - "404": - description: "Bundle not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/bundles/pagination: + get: + tags: + - "Bundle" + summary: "List bundles" + description: "" + operationId: "getBundles" + produces: + - "application/json" + parameters: + - name: "offset" + in: "query" + required: false + type: "integer" + default: 0 + format: "int64" + - name: "limit" + in: "query" + required: false + type: "integer" + default: 100 + format: "int64" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" + responses: + "200": + description: "successful operation" + schema: + type: "array" + items: + $ref: "#/definitions/Bundle" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/bundles/{bundleId}/block: post: tags: - - "Bundle" + - "Bundle" summary: "Block a bundle" description: "" operationId: "addBundleBlockingState" consumes: - - "application/json" + - "application/json" parameters: - - name: "bundleId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/BlockingState" - - name: "requestedDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "bundleId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/BlockingState" + - name: "requestedDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "201": description: "Blocking state created successfully" @@ -2937,267 +2981,265 @@ paths: "404": description: "Bundle not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/bundles/{bundleId}/customFields: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/bundles/{bundleId}/auditLogsWithHistory: get: tags: - - "Bundle" - summary: "Retrieve bundle custom fields" + - "Bundle" + summary: "Retrieve bundle audit logs with history by id" description: "" - operationId: "getBundleCustomFields" + operationId: "getBundleAuditLogsWithHistory" produces: - - "application/json" + - "application/json" parameters: - - name: "bundleId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" - responses: + - name: "bundleId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + responses: "200": description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/CustomField" - "400": - description: "Invalid bundle id supplied" + $ref: "#/definitions/AuditLog" + "404": + description: "Subscription bundle not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - post: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/bundles: + get: tags: - - "Bundle" - summary: "Add custom fields to bundle" + - "Bundle" + summary: "Retrieve a bundle by external key" description: "" - operationId: "createBundleCustomFields" - consumes: - - "application/json" + operationId: "getBundleByKey" produces: - - "application/json" + - "application/json" parameters: - - name: "bundleId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - type: "array" - items: - $ref: "#/definitions/CustomField" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "externalKey" + in: "query" + required: true + type: "string" + - name: "includedDeleted" + in: "query" + required: false + type: "boolean" + default: false + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: - "201": - description: "Custom field created successfully" + "200": + description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/CustomField" - "400": - description: "Invalid bundle id supplied" + $ref: "#/definitions/Bundle" + "404": + description: "Bundle not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/bundles/{bundleId}/pause: put: tags: - - "Bundle" - summary: "Modify custom fields to bundle" + - "Bundle" + summary: "Pause a bundle" description: "" - operationId: "modifyBundleCustomFields" + operationId: "pauseBundle" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "bundleId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: + - name: "bundleId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "requestedDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "pluginProperty" + in: "query" + required: false type: "array" items: - $ref: "#/definitions/CustomField" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "204": description: "Successful operation" "400": description: "Invalid bundle id supplied" + "404": + description: "Bundle not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - delete: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/bundles/{bundleId}/renameKey: + put: tags: - - "Bundle" - summary: "Remove custom fields from bundle" + - "Bundle" + summary: "Update a bundle externalKey" description: "" - operationId: "deleteBundleCustomFields" + operationId: "renameExternalKey" consumes: - - "application/json" - produces: - - "application/json" + - "application/json" parameters: - - name: "bundleId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "customField" - in: "query" - required: false - type: "array" - items: + - name: "bundleId" + in: "path" + required: true type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/Bundle" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "204": description: "Successful operation" "400": - description: "Invalid bundle id supplied" + description: "Invalid argumnent supplied" + "404": + description: "Bundle not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/bundles/{bundleId}/renameKey: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/bundles/{bundleId}/resume: put: tags: - - "Bundle" - summary: "Update a bundle externalKey" + - "Bundle" + summary: "Resume a bundle" description: "" - operationId: "renameExternalKey" + operationId: "resumeBundle" consumes: - - "application/json" + - "application/json" + produces: + - "application/json" parameters: - - name: "bundleId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/Bundle" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "bundleId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "requestedDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "204": description: "Successful operation" "400": - description: "Invalid argumnent supplied" + description: "Invalid bundle id supplied" "404": description: "Bundle not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/bundles/search/{searchKey}: get: tags: - - "Bundle" + - "Bundle" summary: "Search bundles" description: "" operationId: "searchBundles" produces: - - "application/json" - parameters: - - name: "searchKey" - in: "path" - required: true - type: "string" - pattern: ".*" - - name: "offset" - in: "query" - required: false - type: "integer" - default: 0 - format: "int64" - - name: "limit" - in: "query" - required: false - type: "integer" - default: 100 - format: "int64" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - "application/json" + parameters: + - name: "searchKey" + in: "path" + required: true + type: "string" + pattern: ".*" + - name: "offset" + in: "query" + required: false + type: "integer" + default: 0 + format: "int64" + - name: "limit" + in: "query" + required: false + type: "integer" + default: 100 + format: "int64" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" @@ -3206,494 +3248,452 @@ paths: items: $ref: "#/definitions/Bundle" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/bundles/pagination: - get: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/catalog/simplePlan: + post: tags: - - "Bundle" - summary: "List bundles" + - "Catalog" + summary: "Add a simple plan entry in the current version of the catalog" description: "" - operationId: "getBundles" + operationId: "addSimplePlan" + consumes: + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "offset" - in: "query" - required: false - type: "integer" - default: 0 - format: "int64" - - name: "limit" - in: "query" - required: false - type: "integer" - default: 100 - format: "int64" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/SimplePlan" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: - "200": - description: "successful operation" + "201": + description: "Created new plan successfully" schema: - type: "array" - items: - $ref: "#/definitions/Bundle" + type: "string" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/catalog/plan: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/catalog: get: tags: - - "Catalog" - summary: "Retrieve plan for a given subscription and date" + - "Catalog" + summary: "Retrieve the catalog as JSON" description: "" - operationId: "getPlanForSubscriptionAndDate" + operationId: "getCatalogJson" produces: - - "application/json" + - "application/json" parameters: - - name: "subscriptionId" - in: "query" - required: false - type: "string" - format: "uuid" - - name: "requestedDate" - in: "query" - required: false - type: "string" - format: "date" + - name: "requestedDate" + in: "query" + required: false + type: "string" + format: "date-time" + - name: "accountId" + in: "query" + required: false + type: "string" + format: "uuid" responses: "200": description: "successful operation" schema: - $ref: "#/definitions/Plan" + type: "array" + items: + $ref: "#/definitions/Catalog" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/catalog/phase: - get: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + delete: tags: - - "Catalog" - summary: "Retrieve phase for a given subscription and date" + - "Catalog" + summary: "Delete all versions for a per tenant catalog" description: "" - operationId: "getPhaseForSubscriptionAndDate" - produces: - - "application/json" + operationId: "deleteCatalog" parameters: - - name: "subscriptionId" - in: "query" - required: false - type: "string" - format: "uuid" - - name: "requestedDate" - in: "query" - required: false - type: "string" - format: "date" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: - "200": - description: "successful operation" - schema: - $ref: "#/definitions/Phase" + "204": + description: "Successful operation" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/catalog/product: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/catalog/availableAddons: get: tags: - - "Catalog" - summary: "Retrieve product for a given subscription and date" + - "Catalog" + summary: "Retrieve available add-ons for a given product" description: "" - operationId: "getProductForSubscriptionAndDate" + operationId: "getAvailableAddons" produces: - - "application/json" + - "application/json" parameters: - - name: "subscriptionId" - in: "query" - required: false - type: "string" - format: "uuid" - - name: "requestedDate" - in: "query" - required: false - type: "string" - format: "date" + - name: "baseProductName" + in: "query" + required: false + type: "string" + - name: "priceListName" + in: "query" + required: false + type: "string" + - name: "accountId" + in: "query" + required: false + type: "string" + format: "uuid" responses: "200": description: "successful operation" schema: - $ref: "#/definitions/Product" + type: "array" + items: + $ref: "#/definitions/PlanDetail" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/catalog/priceList: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/catalog/availableBasePlans: get: tags: - - "Catalog" - summary: "Retrieve priceList for a given subscription and date" + - "Catalog" + summary: "Retrieve available base plans" description: "" - operationId: "getPriceListForSubscriptionAndDate" + operationId: "getAvailableBasePlans" produces: - - "application/json" + - "application/json" parameters: - - name: "subscriptionId" - in: "query" - required: false - type: "string" - format: "uuid" - - name: "requestedDate" - in: "query" - required: false - type: "string" - format: "date" + - name: "accountId" + in: "query" + required: false + type: "string" + format: "uuid" responses: "200": description: "successful operation" schema: - $ref: "#/definitions/PriceList" + type: "array" + items: + $ref: "#/definitions/PlanDetail" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/catalog: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/catalog/versions: get: tags: - - "Catalog" - summary: "Retrieve the catalog as JSON" + - "Catalog" + summary: "Retrieve a list of catalog versions" description: "" - operationId: "getCatalogJson" + operationId: "getCatalogVersions" produces: - - "application/json" + - "application/json" parameters: - - name: "requestedDate" - in: "query" - required: false - type: "string" - format: "date-time" - - name: "accountId" - in: "query" - required: false - type: "string" - format: "uuid" + - name: "accountId" + in: "query" + required: false + type: "string" + format: "uuid" responses: "200": description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/Catalog" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - delete: - tags: - - "Catalog" - summary: "Delete all versions for a per tenant catalog" - description: "" - operationId: "deleteCatalog" - parameters: - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "204": - description: "Successful operation" + type: "string" + format: "date-time" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/catalog/xml: get: tags: - - "Catalog" + - "Catalog" summary: "Retrieve the full catalog as XML" description: "" operationId: "getCatalogXml" produces: - - "text/xml" + - "text/xml" parameters: - - name: "requestedDate" - in: "query" - required: false - type: "string" - format: "date-time" - - name: "accountId" - in: "query" - required: false - type: "string" - format: "uuid" + - name: "requestedDate" + in: "query" + required: false + type: "string" + format: "date-time" + - name: "accountId" + in: "query" + required: false + type: "string" + format: "uuid" responses: "200": description: "successful operation" schema: type: "string" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] post: tags: - - "Catalog" + - "Catalog" summary: "Upload the full catalog as XML" description: "" operationId: "uploadCatalogXml" consumes: - - "text/xml" + - "text/xml" parameters: - - in: "body" - name: "body" - required: true - schema: + - in: "body" + name: "body" + required: true + schema: + type: "string" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "201": description: "Catalog XML created successfully" schema: type: "string" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/catalog/xml/validate: - post: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/catalog/phase: + get: tags: - - "Catalog" - summary: "Validate a XML catalog" + - "Catalog" + summary: "Retrieve phase for a given subscription and date" description: "" - operationId: "validateCatalogXml" - consumes: - - "text/xml" + operationId: "getPhaseForSubscriptionAndDate" produces: - - "application/json" + - "application/json" parameters: - - in: "body" - name: "body" - required: true - schema: + - name: "subscriptionId" + in: "query" + required: false type: "string" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + format: "uuid" + - name: "requestedDate" + in: "query" + required: false + type: "string" + format: "date" responses: "200": description: "successful operation" schema: - $ref: "#/definitions/CatalogValidation" + $ref: "#/definitions/Phase" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/catalog/versions: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/catalog/plan: get: tags: - - "Catalog" - summary: "Retrieve a list of catalog versions" + - "Catalog" + summary: "Retrieve plan for a given subscription and date" description: "" - operationId: "getCatalogVersions" + operationId: "getPlanForSubscriptionAndDate" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "query" - required: false - type: "string" - format: "uuid" + - name: "subscriptionId" + in: "query" + required: false + type: "string" + format: "uuid" + - name: "requestedDate" + in: "query" + required: false + type: "string" + format: "date" responses: "200": description: "successful operation" schema: - type: "array" - items: - type: "string" - format: "date-time" + $ref: "#/definitions/Plan" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/catalog/availableAddons: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/catalog/priceList: get: tags: - - "Catalog" - summary: "Retrieve available add-ons for a given product" + - "Catalog" + summary: "Retrieve priceList for a given subscription and date" description: "" - operationId: "getAvailableAddons" + operationId: "getPriceListForSubscriptionAndDate" produces: - - "application/json" + - "application/json" parameters: - - name: "baseProductName" - in: "query" - required: false - type: "string" - - name: "priceListName" - in: "query" - required: false - type: "string" - - name: "accountId" - in: "query" - required: false - type: "string" - format: "uuid" + - name: "subscriptionId" + in: "query" + required: false + type: "string" + format: "uuid" + - name: "requestedDate" + in: "query" + required: false + type: "string" + format: "date" responses: "200": description: "successful operation" schema: - type: "array" - items: - $ref: "#/definitions/PlanDetail" + $ref: "#/definitions/PriceList" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/catalog/availableBasePlans: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/catalog/product: get: tags: - - "Catalog" - summary: "Retrieve available base plans" + - "Catalog" + summary: "Retrieve product for a given subscription and date" description: "" - operationId: "getAvailableBasePlans" + operationId: "getProductForSubscriptionAndDate" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "query" - required: false - type: "string" - format: "uuid" + - name: "subscriptionId" + in: "query" + required: false + type: "string" + format: "uuid" + - name: "requestedDate" + in: "query" + required: false + type: "string" + format: "date" responses: "200": description: "successful operation" schema: - type: "array" - items: - $ref: "#/definitions/PlanDetail" + $ref: "#/definitions/Product" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/catalog/simplePlan: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/catalog/xml/validate: post: tags: - - "Catalog" - summary: "Add a simple plan entry in the current version of the catalog" + - "Catalog" + summary: "Validate a XML catalog" description: "" - operationId: "addSimplePlan" + operationId: "validateCatalogXml" consumes: - - "application/json" + - "text/xml" produces: - - "application/json" + - "application/json" parameters: - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/SimplePlan" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "201": - description: "Created new plan successfully" + - in: "body" + name: "body" + required: true schema: type: "string" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "200": + description: "successful operation" + schema: + $ref: "#/definitions/CatalogValidation" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/credits: post: tags: - - "Credit" + - "Credit" summary: "Create a credit" description: "" operationId: "createCredits" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - in: "body" - name: "body" - required: true - schema: + - in: "body" + name: "body" + required: true + schema: + type: "array" + items: + $ref: "#/definitions/InvoiceItem" + - name: "autoCommit" + in: "query" + required: false + type: "boolean" + default: false + - name: "pluginProperty" + in: "query" + required: false type: "array" items: - $ref: "#/definitions/InvoiceItem" - - name: "autoCommit" - in: "query" - required: false - type: "boolean" - default: false - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "201": description: "Created credit successfully" @@ -3706,25 +3706,25 @@ paths: "404": description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/credits/{creditId}: get: tags: - - "Credit" + - "Credit" summary: "Retrieve a credit by id" description: "" operationId: "getCredit" produces: - - "application/json" + - "application/json" parameters: - - name: "creditId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" + - name: "creditId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" responses: "200": description: "successful operation" @@ -3735,52 +3735,45 @@ paths: "404": description: "Credit not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/customFields/search: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/customFields/search/{searchKey}: get: tags: - - "CustomField" - summary: "Search custom fields by type, name and optional value" + - "CustomField" + summary: "Search custom fields" description: "" - operationId: "searchCustomFieldsByTypeName" + operationId: "searchCustomFields" produces: - - "application/json" - parameters: - - name: "objectType" - in: "query" - required: false - type: "string" - - name: "fieldName" - in: "query" - required: false - type: "string" - - name: "fieldValue" - in: "query" - required: false - type: "string" - - name: "offset" - in: "query" - required: false - type: "integer" - default: 0 - format: "int64" - - name: "limit" - in: "query" - required: false - type: "integer" - default: 100 - format: "int64" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - "application/json" + parameters: + - name: "searchKey" + in: "path" + required: true + type: "string" + pattern: ".*" + - name: "offset" + in: "query" + required: false + type: "integer" + default: 0 + format: "int64" + - name: "limit" + in: "query" + required: false + type: "integer" + default: 100 + format: "int64" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" @@ -3789,116 +3782,123 @@ paths: items: $ref: "#/definitions/CustomField" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/customFields/{customFieldId}/auditLogsWithHistory: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/customFields/pagination: get: tags: - - "CustomField" - summary: "Retrieve custom field audit logs with history by id" + - "CustomField" + summary: "List custom fields" description: "" - operationId: "getCustomFieldAuditLogsWithHistory" + operationId: "getCustomFields" produces: - - "application/json" - parameters: - - name: "customFieldId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" + - "application/json" + parameters: + - name: "offset" + in: "query" + required: false + type: "integer" + default: 0 + format: "int64" + - name: "limit" + in: "query" + required: false + type: "integer" + default: 100 + format: "int64" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/AuditLog" - "404": - description: "Account not found" + $ref: "#/definitions/CustomField" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/customFields/search/{searchKey}: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/customFields/{customFieldId}/auditLogsWithHistory: get: tags: - - "CustomField" - summary: "Search custom fields" + - "CustomField" + summary: "Retrieve custom field audit logs with history by id" description: "" - operationId: "searchCustomFields" + operationId: "getCustomFieldAuditLogsWithHistory" produces: - - "application/json" + - "application/json" parameters: - - name: "searchKey" - in: "path" - required: true - type: "string" - pattern: ".*" - - name: "offset" - in: "query" - required: false - type: "integer" - default: 0 - format: "int64" - - name: "limit" - in: "query" - required: false - type: "integer" - default: 100 - format: "int64" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "customFieldId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" responses: "200": description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/CustomField" + $ref: "#/definitions/AuditLog" + "404": + description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/customFields/pagination: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/customFields/search: get: tags: - - "CustomField" - summary: "List custom fields" + - "CustomField" + summary: "Search custom fields by type, name and optional value" description: "" - operationId: "getCustomFields" + operationId: "searchCustomFieldsByTypeName" produces: - - "application/json" - parameters: - - name: "offset" - in: "query" - required: false - type: "integer" - default: 0 - format: "int64" - - name: "limit" - in: "query" - required: false - type: "integer" - default: 100 - format: "int64" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - "application/json" + parameters: + - name: "objectType" + in: "query" + required: false + type: "string" + - name: "fieldName" + in: "query" + required: false + type: "string" + - name: "fieldValue" + in: "query" + required: false + type: "string" + - name: "offset" + in: "query" + required: false + type: "integer" + default: 0 + format: "int64" + - name: "limit" + in: "query" + required: false + type: "integer" + default: 100 + format: "int64" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" @@ -3907,37 +3907,37 @@ paths: items: $ref: "#/definitions/CustomField" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/export/{accountId}: get: tags: - - "Export" + - "Export" summary: "Export account data" description: "" operationId: "exportDataForAccount" produces: - - "application/octet-stream" + - "application/octet-stream" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "200": description: "Success" @@ -3946,378 +3946,349 @@ paths: "404": description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoiceItems/{invoiceItemId}/auditLogsWithHistory: - get: - tags: - - "InvoiceItem" - summary: "Retrieve invoice item audit logs with history by id" - description: "" - operationId: "getInvoiceItemAuditLogsWithHistory" - produces: - - "application/json" - parameters: - - name: "invoiceItemId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - responses: - "200": - description: "successful operation" - schema: - type: "array" - items: - $ref: "#/definitions/AuditLog" - "404": - description: "Invoice item not found" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoiceItems/{invoiceItemId}/customFields: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoiceItems/{invoiceItemId}/tags: get: tags: - - "InvoiceItem" - summary: "Retrieve invoice item custom fields" + - "InvoiceItem" + summary: "Retrieve invoice item tags" description: "" - operationId: "getInvoiceItemCustomFields" + operationId: "getInvoiceItemTags" produces: - - "application/json" + - "application/json" parameters: - - name: "invoiceItemId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "invoiceItemId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "accountId" + in: "query" + required: true + type: "string" + format: "uuid" + - name: "includedDeleted" + in: "query" + required: false + type: "boolean" + default: false + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/CustomField" + $ref: "#/definitions/Tag" "400": description: "Invalid invoice item id supplied" + "404": + description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] post: tags: - - "InvoiceItem" - summary: "Add custom fields to invoice item" + - "InvoiceItem" + summary: "Add tags to invoice item" description: "" - operationId: "createInvoiceItemCustomFields" + operationId: "createInvoiceItemTags" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "invoiceItemId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - type: "array" - items: - $ref: "#/definitions/CustomField" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "invoiceItemId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + type: "array" + items: + type: "string" + format: "uuid" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "201": - description: "Custom field created successfully" + description: "Tag created successfully" schema: type: "array" items: - $ref: "#/definitions/CustomField" + $ref: "#/definitions/Tag" "400": description: "Invalid invoice item id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - put: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + delete: tags: - - "InvoiceItem" - summary: "Modify custom fields to invoice item" + - "InvoiceItem" + summary: "Remove tags from invoice item" description: "" - operationId: "modifyInvoiceItemCustomFields" + operationId: "deleteInvoiceItemTags" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "invoiceItemId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: + - name: "invoiceItemId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "tagDef" + in: "query" + required: false type: "array" items: - $ref: "#/definitions/CustomField" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + type: "string" + format: "uuid" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "204": description: "Successful operation" "400": description: "Invalid invoice item id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - delete: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoiceItems/{invoiceItemId}/customFields: + get: tags: - - "InvoiceItem" - summary: "Remove custom fields from invoice item" + - "InvoiceItem" + summary: "Retrieve invoice item custom fields" description: "" - operationId: "deleteInvoiceItemCustomFields" - consumes: - - "application/json" + operationId: "getInvoiceItemCustomFields" produces: - - "application/json" + - "application/json" parameters: - - name: "invoiceItemId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "customField" - in: "query" - required: false - type: "array" - items: + - name: "invoiceItemId" + in: "path" + required: true type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: - "204": - description: "Successful operation" + "200": + description: "successful operation" + schema: + type: "array" + items: + $ref: "#/definitions/CustomField" "400": description: "Invalid invoice item id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoiceItems/{invoiceItemId}/tags: - get: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + post: tags: - - "InvoiceItem" - summary: "Retrieve invoice item tags" + - "InvoiceItem" + summary: "Add custom fields to invoice item" description: "" - operationId: "getInvoiceItemTags" + operationId: "createInvoiceItemCustomFields" + consumes: + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "invoiceItemId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "accountId" - in: "query" - required: true - type: "string" - format: "uuid" - - name: "includedDeleted" - in: "query" - required: false - type: "boolean" - default: false - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "invoiceItemId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + type: "array" + items: + $ref: "#/definitions/CustomField" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: - "200": - description: "successful operation" + "201": + description: "Custom field created successfully" schema: type: "array" items: - $ref: "#/definitions/Tag" + $ref: "#/definitions/CustomField" "400": description: "Invalid invoice item id supplied" - "404": - description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - post: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + put: tags: - - "InvoiceItem" - summary: "Add tags to invoice item" + - "InvoiceItem" + summary: "Modify custom fields to invoice item" description: "" - operationId: "createInvoiceItemTags" + operationId: "modifyInvoiceItemCustomFields" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "invoiceItemId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - type: "array" - items: - type: "string" - format: "uuid" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "201": - description: "Tag created successfully" + - name: "invoiceItemId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true schema: type: "array" items: - $ref: "#/definitions/Tag" + $ref: "#/definitions/CustomField" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "204": + description: "Successful operation" "400": description: "Invalid invoice item id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] delete: tags: - - "InvoiceItem" - summary: "Remove tags from invoice item" + - "InvoiceItem" + summary: "Remove custom fields from invoice item" description: "" - operationId: "deleteInvoiceItemTags" + operationId: "deleteInvoiceItemCustomFields" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "invoiceItemId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "tagDef" - in: "query" - required: false - type: "array" - items: + - name: "invoiceItemId" + in: "path" + required: true type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "customField" + in: "query" + required: false + type: "array" + items: + type: "string" + format: "uuid" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "204": description: "Successful operation" "400": description: "Invalid invoice item id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoicePayments/{invoicePaymentId}/auditLogsWithHistory: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoiceItems/{invoiceItemId}/auditLogsWithHistory: get: tags: - - "InvoicePayment" - summary: "Retrieve invoice payment audit logs with history by id" + - "InvoiceItem" + summary: "Retrieve invoice item audit logs with history by id" description: "" - operationId: "getInvoicePaymentAuditLogsWithHistory" + operationId: "getInvoiceItemAuditLogsWithHistory" produces: - - "application/json" + - "application/json" parameters: - - name: "invoicePaymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" + - name: "invoiceItemId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" responses: "200": description: "successful operation" @@ -4326,118 +4297,201 @@ paths: items: $ref: "#/definitions/AuditLog" "404": - description: "Invoice payment not found" + description: "Invoice item not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoicePayments/{paymentId}/refunds: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoicePayments/{paymentId}/tags: + get: + tags: + - "InvoicePayment" + summary: "Retrieve payment tags" + description: "" + operationId: "getInvoicePaymentTags" + produces: + - "application/json" + parameters: + - name: "paymentId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "includedDeleted" + in: "query" + required: false + type: "boolean" + default: false + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" + responses: + "200": + description: "successful operation" + schema: + type: "array" + items: + $ref: "#/definitions/Tag" + "400": + description: "Invalid payment id supplied" + "404": + description: "Payment not found" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] post: tags: - - "InvoicePayment" - summary: "Refund a payment, and adjust the invoice if needed" + - "InvoicePayment" + summary: "Add tags to payment" description: "" - operationId: "createRefundWithAdjustments" + operationId: "createInvoicePaymentTags" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/InvoicePaymentTransaction" - - name: "externalPayment" - in: "query" - required: false - type: "boolean" - default: false - - name: "paymentMethodId" - in: "query" - required: false - type: "string" - format: "uuid" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "paymentId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + type: "array" + items: + type: "string" + format: "uuid" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "201": - description: "Created refund successfully" + description: "Tag created successfully" schema: - $ref: "#/definitions/InvoicePayment" + type: "array" + items: + $ref: "#/definitions/Tag" + "400": + description: "Invalid payment id supplied" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + delete: + tags: + - "InvoicePayment" + summary: "Remove tags from payment" + description: "" + operationId: "deleteInvoicePaymentTags" + consumes: + - "application/json" + produces: + - "application/json" + parameters: + - name: "paymentId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "tagDef" + in: "query" + required: false + type: "array" + items: + type: "string" + format: "uuid" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "204": + description: "Successful operation" "400": description: "Invalid payment id supplied" - "404": - description: "Account or payment not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/invoicePayments/{paymentId}: get: tags: - - "InvoicePayment" + - "InvoicePayment" summary: "Retrieve a payment by id" description: "" operationId: "getInvoicePayment" produces: - - "application/json" + - "application/json" parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "withPluginInfo" - in: "query" - required: false - type: "boolean" - default: false - - name: "withAttempts" - in: "query" - required: false - type: "boolean" - default: false - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "paymentId" + in: "path" + required: true type: "string" - collectionFormat: "multi" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "withPluginInfo" + in: "query" + required: false + type: "boolean" + default: false + - name: "withAttempts" + in: "query" + required: false + type: "boolean" + default: false + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" @@ -4448,57 +4502,57 @@ paths: "404": description: "Payment not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] put: tags: - - "InvoicePayment" + - "InvoicePayment" summary: "Complete an existing transaction" description: "" operationId: "completeInvoicePaymentTransaction" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/PaymentTransaction" - - name: "controlPluginName" - in: "query" - required: false - type: "array" - items: + - name: "paymentId" + in: "path" + required: true type: "string" - collectionFormat: "multi" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/PaymentTransaction" + - name: "controlPluginName" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "204": description: "Successful operation" @@ -4517,34 +4571,34 @@ paths: "504": description: "Payment operation timeout" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/invoicePayments/{paymentId}/customFields: get: tags: - - "InvoicePayment" + - "InvoicePayment" summary: "Retrieve payment custom fields" description: "" operationId: "getInvoicePaymentCustomFields" produces: - - "application/json" + - "application/json" parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "paymentId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" @@ -4555,45 +4609,45 @@ paths: "400": description: "Invalid payment id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] post: tags: - - "InvoicePayment" + - "InvoicePayment" summary: "Add custom fields to payment" description: "" operationId: "createInvoicePaymentCustomFields" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - type: "array" - items: - $ref: "#/definitions/CustomField" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "paymentId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + type: "array" + items: + $ref: "#/definitions/CustomField" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "201": description: "Custom field created successfully" @@ -4604,293 +4658,200 @@ paths: "400": description: "Invalid payment id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] put: tags: - - "InvoicePayment" + - "InvoicePayment" summary: "Modify custom fields to payment" description: "" operationId: "modifyInvoicePaymentCustomFields" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - type: "array" - items: - $ref: "#/definitions/CustomField" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "paymentId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + type: "array" + items: + $ref: "#/definitions/CustomField" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "204": description: "Successful operation" "400": description: "Invalid payment id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] delete: tags: - - "InvoicePayment" + - "InvoicePayment" summary: "Remove custom fields from payment" description: "" operationId: "deleteInvoicePaymentCustomFields" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "customField" - in: "query" - required: false - type: "array" - items: + - name: "paymentId" + in: "path" + required: true type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "customField" + in: "query" + required: false + type: "array" + items: + type: "string" + format: "uuid" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "204": description: "Successful operation" "400": description: "Invalid payment id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoicePayments/{paymentId}/tags: - get: - tags: - - "InvoicePayment" - summary: "Retrieve payment tags" - description: "" - operationId: "getInvoicePaymentTags" - produces: - - "application/json" - parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "includedDeleted" - in: "query" - required: false - type: "boolean" - default: false - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: - type: "string" - collectionFormat: "multi" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" - responses: - "200": - description: "successful operation" - schema: - type: "array" - items: - $ref: "#/definitions/Tag" - "400": - description: "Invalid payment id supplied" - "404": - description: "Payment not found" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoicePayments/{paymentId}/chargebacks: post: tags: - - "InvoicePayment" - summary: "Add tags to payment" + - "InvoicePayment" + summary: "Record a chargeback" description: "" - operationId: "createInvoicePaymentTags" + operationId: "createChargeback" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: + - name: "paymentId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/InvoicePaymentTransaction" + - name: "pluginProperty" + in: "query" + required: false type: "array" items: type: "string" - format: "uuid" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "201": - description: "Tag created successfully" + description: "Created chargeback successfully" schema: - type: "array" - items: - $ref: "#/definitions/Tag" + $ref: "#/definitions/InvoicePayment" "400": description: "Invalid payment id supplied" + "404": + description: "Account or payment not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - delete: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoicePayments/{paymentId}/chargebackReversals: + post: tags: - - "InvoicePayment" - summary: "Remove tags from payment" + - "InvoicePayment" + summary: "Record a chargebackReversal" description: "" - operationId: "deleteInvoicePaymentTags" + operationId: "createChargebackReversal" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "tagDef" - in: "query" - required: false - type: "array" - items: + - name: "paymentId" + in: "path" + required: true type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "204": - description: "Successful operation" - "400": - description: "Invalid payment id supplied" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoicePayments/{paymentId}/chargebacks: - post: - tags: - - "InvoicePayment" - summary: "Record a chargeback" - description: "" - operationId: "createChargeback" - consumes: - - "application/json" - produces: - - "application/json" - parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/InvoicePaymentTransaction" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/InvoicePaymentTransaction" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "201": - description: "Created chargeback successfully" + description: "Created chargeback reversal successfully" schema: $ref: "#/definitions/InvoicePayment" "400": @@ -4898,54 +4859,64 @@ paths: "404": description: "Account or payment not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoicePayments/{paymentId}/chargebackReversals: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoicePayments/{paymentId}/refunds: post: tags: - - "InvoicePayment" - summary: "Record a chargebackReversal" + - "InvoicePayment" + summary: "Refund a payment, and adjust the invoice if needed" description: "" - operationId: "createChargebackReversal" + operationId: "createRefundWithAdjustments" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/InvoicePaymentTransaction" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "paymentId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/InvoicePaymentTransaction" + - name: "externalPayment" + in: "query" + required: false + type: "boolean" + default: false + - name: "paymentMethodId" + in: "query" + required: false + type: "string" + format: "uuid" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "201": - description: "Created chargeback reversal successfully" + description: "Created refund successfully" schema: $ref: "#/definitions/InvoicePayment" "400": @@ -4953,25 +4924,25 @@ paths: "404": description: "Account or payment not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoices/{invoiceId}/auditLogsWithHistory: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoicePayments/{invoicePaymentId}/auditLogsWithHistory: get: tags: - - "Invoice" - summary: "Retrieve invoice audit logs with history by id" + - "InvoicePayment" + summary: "Retrieve invoice payment audit logs with history by id" description: "" - operationId: "getInvoiceAuditLogsWithHistory" + operationId: "getInvoicePaymentAuditLogsWithHistory" produces: - - "application/json" + - "application/json" parameters: - - name: "invoiceId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" + - name: "invoicePaymentId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" responses: "200": description: "successful operation" @@ -4980,41 +4951,41 @@ paths: items: $ref: "#/definitions/AuditLog" "404": - description: "Invoice not found" + description: "Invoice payment not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/invoices/{invoiceId}/tags: get: tags: - - "Invoice" + - "Invoice" summary: "Retrieve invoice tags" description: "" operationId: "getInvoiceTags" produces: - - "application/json" + - "application/json" parameters: - - name: "invoiceId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "includedDeleted" - in: "query" - required: false - type: "boolean" - default: false - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "invoiceId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "includedDeleted" + in: "query" + required: false + type: "boolean" + default: false + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" @@ -5027,46 +4998,46 @@ paths: "404": description: "Invoice not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] post: tags: - - "Invoice" + - "Invoice" summary: "Add tags to invoice" description: "" operationId: "createInvoiceTags" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "invoiceId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - type: "array" - items: - type: "string" - format: "uuid" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "invoiceId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + type: "array" + items: + type: "string" + format: "uuid" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "201": description: "Tag created successfully" @@ -5077,90 +5048,86 @@ paths: "400": description: "Invalid invoice id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] delete: tags: - - "Invoice" + - "Invoice" summary: "Remove tags from invoice" description: "" operationId: "deleteInvoiceTags" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "invoiceId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "tagDef" - in: "query" - required: false - type: "array" - items: + - name: "invoiceId" + in: "path" + required: true type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "tagDef" + in: "query" + required: false + type: "array" + items: + type: "string" + format: "uuid" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "204": description: "Successful operation" "400": description: "Invalid invoice id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoices/{groupId}/group: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoices/pagination: get: tags: - - "Invoice" - summary: "Retrieve a set of invoices by group id" + - "Invoice" + summary: "List invoices" description: "" - operationId: "getInvoicesGroup" + operationId: "getInvoices" produces: - - "application/json" - parameters: - - name: "groupId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "accountId" - in: "query" - required: true - type: "string" - format: "uuid" - - name: "withChildrenItems" - in: "query" - required: false - type: "boolean" - default: false - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - "application/json" + parameters: + - name: "offset" + in: "query" + required: false + type: "integer" + default: 0 + format: "int64" + - name: "limit" + in: "query" + required: false + type: "integer" + default: 100 + format: "int64" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" @@ -5168,1155 +5135,1145 @@ paths: type: "array" items: $ref: "#/definitions/Invoice" - "400": - description: "Invalid group id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoices/byItemId/{itemId}: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoices/search/{searchKey}: get: tags: - - "Invoice" - summary: "Retrieve an invoice by invoice item id" + - "Invoice" + summary: "Search invoices" description: "" - operationId: "getInvoiceByItemId" + operationId: "searchInvoices" + produces: + - "application/json" + parameters: + - name: "searchKey" + in: "path" + required: true + type: "string" + pattern: ".*" + - name: "offset" + in: "query" + required: false + type: "integer" + default: 0 + format: "int64" + - name: "limit" + in: "query" + required: false + type: "integer" + default: 100 + format: "int64" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" + responses: + "200": + description: "successful operation" + schema: + type: "array" + items: + $ref: "#/definitions/Invoice" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoices/{invoiceId}: + get: + tags: + - "Invoice" + summary: "Retrieve an invoice by id" + description: "" + operationId: "getInvoice" produces: - - "application/json" + - "application/json" parameters: - - name: "itemId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "withChildrenItems" - in: "query" - required: false - type: "boolean" - default: false - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "invoiceId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "withChildrenItems" + in: "query" + required: false + type: "boolean" + default: false + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" schema: $ref: "#/definitions/Invoice" + "400": + description: "Invalid invoice id supplied" "404": description: "Invoice not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoices: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] post: tags: - - "Invoice" - summary: "Trigger an invoice generation" + - "Invoice" + summary: "Adjust an invoice item" description: "" - operationId: "createFutureInvoice" + operationId: "adjustInvoiceItem" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "query" - required: true - type: "string" - format: "uuid" - - name: "targetDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "invoiceId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/InvoiceItem" + - name: "requestedDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "201": - description: "Created invoice successfully" + description: "Created adjustment Successfully" schema: $ref: "#/definitions/Invoice" "400": - description: "Invalid account id or target datetime supplied" + description: "Invalid account id, invoice id or invoice item id supplied" + "404": + description: "Invoice not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoices/group: - post: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoices/byNumber/{invoiceNumber}: + get: tags: - - "Invoice" - summary: "Trigger an invoice generation" + - "Invoice" + summary: "Retrieve an invoice by number" description: "" - operationId: "createFutureInvoiceGroup" - consumes: - - "application/json" + operationId: "getInvoiceByNumber" produces: - - "application/json" - parameters: - - name: "accountId" - in: "query" - required: true - type: "string" - format: "uuid" - - name: "targetDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: - type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - "application/json" + parameters: + - name: "invoiceNumber" + in: "path" + required: true + type: "integer" + pattern: "[0-9]+" + format: "int32" + - name: "withChildrenItems" + in: "query" + required: false + type: "boolean" + default: false + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: - "201": - description: "Created invoice successfully" + "200": + description: "successful operation" schema: - type: "array" - items: - $ref: "#/definitions/Invoice" - "400": - description: "Invalid account id or target datetime supplied" + $ref: "#/definitions/Invoice" + "404": + description: "Invoice not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoices/dryRun: - post: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoices/{invoiceId}/{invoiceItemId}/cba: + delete: tags: - - "Invoice" - summary: "Generate a dryRun invoice" + - "Invoice" + summary: "Delete a CBA item" description: "" - operationId: "generateDryRunInvoice" + operationId: "deleteCBA" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/InvoiceDryRun" - - name: "accountId" - in: "query" - required: true - type: "string" - format: "uuid" - - name: "targetDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "invoiceId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "invoiceItemId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "accountId" + in: "query" + required: true + type: "string" + format: "uuid" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: - "200": - description: "successful operation" - schema: - $ref: "#/definitions/Invoice" "204": - description: "Nothing to generate" + description: "Successful operation" "400": - description: "Invalid account id or target datetime supplied" + description: "Invalid account id, invoice id or invoice item id supplied" + "404": + description: "Account or invoice not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoices/{invoiceId}: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoices/{invoiceId}/html: get: tags: - - "Invoice" - summary: "Retrieve an invoice by id" + - "Invoice" + summary: "Render an invoice as HTML" description: "" - operationId: "getInvoice" + operationId: "getInvoiceAsHTML" produces: - - "application/json" + - "text/html" parameters: - - name: "invoiceId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "withChildrenItems" - in: "query" - required: false - type: "boolean" - default: false - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "invoiceId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" responses: "200": description: "successful operation" schema: - $ref: "#/definitions/Invoice" - "400": - description: "Invalid invoice id supplied" + type: "string" "404": description: "Invoice not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - post: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoices/{invoiceId}/commitInvoice: + put: tags: - - "Invoice" - summary: "Adjust an invoice item" + - "Invoice" + summary: "Perform the invoice status transition from DRAFT to COMMITTED" description: "" - operationId: "adjustInvoiceItem" + operationId: "commitInvoice" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "invoiceId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/InvoiceItem" - - name: "requestedDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "invoiceId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: - "201": - description: "Created adjustment Successfully" - schema: - $ref: "#/definitions/Invoice" - "400": - description: "Invalid account id, invoice id or invoice item id supplied" + "204": + description: "Successful operation" "404": description: "Invoice not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoices/charges/{accountId}: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoices/migration/{accountId}: post: tags: - - "Invoice" - summary: "Create external charge(s)" + - "Invoice" + summary: "Create a migration invoice" description: "" - operationId: "createExternalCharges" + operationId: "createMigrationInvoice" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - type: "array" - items: - $ref: "#/definitions/InvoiceItem" - - name: "requestedDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "autoCommit" - in: "query" - required: false - type: "boolean" - default: false - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "accountId" + in: "path" + required: true type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "201": - description: "Created external charge Successfully" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true schema: type: "array" items: $ref: "#/definitions/InvoiceItem" + - name: "targetDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "201": + description: "Created migration invoice successfully" + schema: + $ref: "#/definitions/Invoice" "400": - description: "Invalid account id supplied" - "404": - description: "Account not found" + description: "Invalid account id or target datetime supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoices/taxes/{accountId}: - post: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoices/{invoiceId}/voidInvoice: + put: tags: - - "Invoice" - summary: "Create tax items" + - "Invoice" + summary: "Perform the action of voiding an invoice" description: "" - operationId: "createTaxItems" + operationId: "voidInvoice" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - type: "array" - items: - $ref: "#/definitions/InvoiceItem" - - name: "autoCommit" - in: "query" - required: false - type: "boolean" - default: false - - name: "requestedDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "invoiceId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: - "201": - description: "Create tax items successfully" - schema: - type: "array" - items: - $ref: "#/definitions/InvoiceItem" + "204": + description: "Successful operation" "400": - description: "Invalid account id supplied" + description: "Invalid invoice id supplied" "404": - description: "Account not found" + description: "Invoice not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoices/{invoiceId}/payments: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoices/{invoiceId}/customFields: get: tags: - - "Invoice" - summary: "Retrieve payments associated with an invoice" + - "Invoice" + summary: "Retrieve invoice custom fields" description: "" - operationId: "getPaymentsForInvoice" + operationId: "getInvoiceCustomFields" produces: - - "application/json" + - "application/json" parameters: - - name: "invoiceId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "withPluginInfo" - in: "query" - required: false - type: "boolean" - default: false - - name: "withAttempts" - in: "query" - required: false - type: "boolean" - default: false - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "invoiceId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/InvoicePayment" + $ref: "#/definitions/CustomField" "400": description: "Invalid invoice id supplied" - "404": - description: "Invoice not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] post: tags: - - "Invoice" - summary: "Trigger a payment for invoice" + - "Invoice" + summary: "Add custom fields to invoice" description: "" - operationId: "createInstantPayment" + operationId: "createInvoiceCustomFields" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "invoiceId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/InvoicePayment" - - name: "externalPayment" - in: "query" - required: false - type: "boolean" - default: false - - name: "controlPluginName" - in: "query" - required: false - type: "array" - items: + - name: "invoiceId" + in: "path" + required: true type: "string" - collectionFormat: "multi" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + type: "array" + items: + $ref: "#/definitions/CustomField" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "201": - description: "Created payment Successfully" + description: "Custom field created successfully" schema: - $ref: "#/definitions/InvoicePayment" - "204": - description: "Nothing to pay for" + type: "array" + items: + $ref: "#/definitions/CustomField" "400": - description: "Invalid account id or invoice id supplied" - "404": - description: "Account not found" + description: "Invalid invoice id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoices/translation/{locale}: - get: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + put: tags: - - "Invoice" - summary: "Retrieves the invoice translation for the tenant" + - "Invoice" + summary: "Modify custom fields to invoice" description: "" - operationId: "getInvoiceTranslation" + operationId: "modifyInvoiceCustomFields" + consumes: + - "application/json" produces: - - "text/plain" + - "application/json" parameters: - - name: "locale" - in: "path" - required: true - type: "string" - pattern: ".*" - responses: - "200": - description: "successful operation" + - name: "invoiceId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true schema: - type: "string" + type: "array" + items: + $ref: "#/definitions/CustomField" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "204": + description: "Successful operation" "400": - description: "Invalid locale supplied" - "404": - description: "Translation not found" + description: "Invalid invoice id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - post: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + delete: tags: - - "Invoice" - summary: "Upload the invoice translation for the tenant" + - "Invoice" + summary: "Remove custom fields from invoice" description: "" - operationId: "uploadInvoiceTranslation" + operationId: "deleteInvoiceCustomFields" consumes: - - "text/plain" + - "application/json" produces: - - "text/plain" + - "application/json" parameters: - - name: "locale" - in: "path" - required: true - type: "string" - pattern: ".*" - - in: "body" - name: "body" - required: true - schema: + - name: "invoiceId" + in: "path" + required: true type: "string" - - name: "deleteIfExists" - in: "query" - required: false - type: "boolean" - default: false - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "201": - description: "Uploaded invoice translation Successfully" - schema: + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "customField" + in: "query" + required: false + type: "array" + items: type: "string" + format: "uuid" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "204": + description: "Successful operation" + "400": + description: "Invalid invoice id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoices/catalogTranslation/{locale}: - get: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoices/charges/{accountId}: + post: tags: - - "Invoice" - summary: "Retrieves the catalog translation for the tenant" + - "Invoice" + summary: "Create external charge(s)" description: "" - operationId: "getCatalogTranslation" + operationId: "createExternalCharges" + consumes: + - "application/json" produces: - - "text/plain" + - "application/json" parameters: - - name: "locale" - in: "path" - required: true - type: "string" - pattern: ".*" - responses: - "200": - description: "successful operation" + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true schema: + type: "array" + items: + $ref: "#/definitions/InvoiceItem" + - name: "requestedDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "autoCommit" + in: "query" + required: false + type: "boolean" + default: false + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "201": + description: "Created external charge Successfully" + schema: + type: "array" + items: + $ref: "#/definitions/InvoiceItem" "400": - description: "Invalid locale supplied" + description: "Invalid account id supplied" "404": - description: "Template not found" + description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoices: post: tags: - - "Invoice" - summary: "Upload the catalog translation for the tenant" + - "Invoice" + summary: "Trigger an invoice generation" description: "" - operationId: "uploadCatalogTranslation" + operationId: "createFutureInvoice" consumes: - - "text/plain" + - "application/json" produces: - - "text/plain" + - "application/json" parameters: - - name: "locale" - in: "path" - required: true - type: "string" - pattern: ".*" - - in: "body" - name: "body" - required: true - schema: + - name: "accountId" + in: "query" + required: true type: "string" - - name: "deleteIfExists" - in: "query" - required: false - type: "boolean" - default: false - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "201": - description: "Uploaded catalog translation Successfully" - schema: + format: "uuid" + - name: "targetDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: type: "string" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoices/template: - get: - tags: - - "Invoice" - summary: "Retrieves the invoice template for the tenant" - description: "" - operationId: "getInvoiceTemplate" - produces: - - "text/html" - parameters: [] + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: - "200": - description: "successful operation" + "201": + description: "Created invoice successfully" schema: - type: "string" - "404": - description: "Template not found" + $ref: "#/definitions/Invoice" + "400": + description: "Invalid account id or target datetime supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoices/group: post: tags: - - "Invoice" - summary: "Upload the invoice template for the tenant" + - "Invoice" + summary: "Trigger an invoice generation" description: "" - operationId: "uploadInvoiceTemplate" + operationId: "createFutureInvoiceGroup" consumes: - - "text/html" + - "application/json" produces: - - "text/html" + - "application/json" parameters: - - in: "body" - name: "body" - required: true - schema: + - name: "accountId" + in: "query" + required: true + type: "string" + format: "uuid" + - name: "targetDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - - name: "deleteIfExists" - in: "query" - required: false - type: "boolean" - default: false - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "201": - description: "Uploaded invoice template Successfully" + description: "Created invoice successfully" schema: - type: "string" + type: "array" + items: + $ref: "#/definitions/Invoice" + "400": + description: "Invalid account id or target datetime supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoices/manualPayTemplate/{locale}: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoices/{invoiceId}/payments: get: tags: - - "Invoice" - summary: "Retrieves the manualPay invoice template for the tenant" + - "Invoice" + summary: "Retrieve payments associated with an invoice" description: "" - operationId: "getInvoiceMPTemplate" + operationId: "getPaymentsForInvoice" produces: - - "text/html" + - "application/json" parameters: - - name: "locale" - in: "path" - required: true - type: "string" - pattern: ".*" + - name: "invoiceId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "withPluginInfo" + in: "query" + required: false + type: "boolean" + default: false + - name: "withAttempts" + in: "query" + required: false + type: "boolean" + default: false + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" schema: - type: "string" + type: "array" + items: + $ref: "#/definitions/InvoicePayment" + "400": + description: "Invalid invoice id supplied" "404": - description: "Template not found" + description: "Invoice not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoices/manualPayTemplate: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] post: tags: - - "Invoice" - summary: "Upload the manualPay invoice template for the tenant" + - "Invoice" + summary: "Trigger a payment for invoice" description: "" - operationId: "uploadInvoiceMPTemplate" + operationId: "createInstantPayment" consumes: - - "text/html" + - "application/json" produces: - - "text/html" + - "application/json" parameters: - - in: "body" - name: "body" - required: true - schema: + - name: "invoiceId" + in: "path" + required: true type: "string" - - name: "deleteIfExists" - in: "query" - required: false - type: "boolean" - default: false - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "200": - description: "successful operation" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true schema: + $ref: "#/definitions/InvoicePayment" + - name: "externalPayment" + in: "query" + required: false + type: "boolean" + default: false + - name: "controlPluginName" + in: "query" + required: false + type: "array" + items: type: "string" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoices/{invoiceId}/customFields: - get: - tags: - - "Invoice" - summary: "Retrieve invoice custom fields" - description: "" - operationId: "getInvoiceCustomFields" - produces: - - "application/json" - parameters: - - name: "invoiceId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + collectionFormat: "multi" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: - "200": - description: "successful operation" + "201": + description: "Created payment Successfully" schema: - type: "array" - items: - $ref: "#/definitions/CustomField" + $ref: "#/definitions/InvoicePayment" + "204": + description: "Nothing to pay for" "400": - description: "Invalid invoice id supplied" + description: "Invalid account id or invoice id supplied" + "404": + description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoices/taxes/{accountId}: post: tags: - - "Invoice" - summary: "Add custom fields to invoice" + - "Invoice" + summary: "Create tax items" description: "" - operationId: "createInvoiceCustomFields" + operationId: "createTaxItems" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "invoiceId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + type: "array" + items: + $ref: "#/definitions/InvoiceItem" + - name: "autoCommit" + in: "query" + required: false + type: "boolean" + default: false + - name: "requestedDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "pluginProperty" + in: "query" + required: false type: "array" items: - $ref: "#/definitions/CustomField" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "201": - description: "Custom field created successfully" + description: "Create tax items successfully" schema: type: "array" items: - $ref: "#/definitions/CustomField" + $ref: "#/definitions/InvoiceItem" "400": - description: "Invalid invoice id supplied" + description: "Invalid account id supplied" + "404": + description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - put: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoices/dryRun: + post: tags: - - "Invoice" - summary: "Modify custom fields to invoice" + - "Invoice" + summary: "Generate a dryRun invoice" description: "" - operationId: "modifyInvoiceCustomFields" + operationId: "generateDryRunInvoice" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "invoiceId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/InvoiceDryRun" + - name: "accountId" + in: "query" + required: true + type: "string" + format: "uuid" + - name: "targetDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "pluginProperty" + in: "query" + required: false type: "array" items: - $ref: "#/definitions/CustomField" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: + "200": + description: "successful operation" + schema: + $ref: "#/definitions/Invoice" "204": - description: "Successful operation" + description: "Nothing to generate" "400": - description: "Invalid invoice id supplied" + description: "Invalid account id or target datetime supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - delete: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoices/catalogTranslation/{locale}: + get: tags: - - "Invoice" - summary: "Remove custom fields from invoice" + - "Invoice" + summary: "Retrieves the catalog translation for the tenant" description: "" - operationId: "deleteInvoiceCustomFields" - consumes: - - "application/json" + operationId: "getCatalogTranslation" produces: - - "application/json" + - "text/plain" parameters: - - name: "invoiceId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "customField" - in: "query" - required: false - type: "array" - items: + - name: "locale" + in: "path" + required: true type: "string" - format: "uuid" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + pattern: ".*" responses: - "204": - description: "Successful operation" + "200": + description: "successful operation" + schema: + type: "string" "400": - description: "Invalid invoice id supplied" + description: "Invalid locale supplied" + "404": + description: "Template not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoices/pagination: - get: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + post: tags: - - "Invoice" - summary: "List invoices" + - "Invoice" + summary: "Upload the catalog translation for the tenant" description: "" - operationId: "getInvoices" + operationId: "uploadCatalogTranslation" + consumes: + - "text/plain" produces: - - "application/json" + - "text/plain" parameters: - - name: "offset" - in: "query" - required: false - type: "integer" - default: 0 - format: "int64" - - name: "limit" - in: "query" - required: false - type: "integer" - default: 100 - format: "int64" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "locale" + in: "path" + required: true + type: "string" + pattern: ".*" + - in: "body" + name: "body" + required: true + schema: + type: "string" + - name: "deleteIfExists" + in: "query" + required: false + type: "boolean" + default: false + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: - "200": - description: "successful operation" + "201": + description: "Uploaded catalog translation Successfully" schema: - type: "array" - items: - $ref: "#/definitions/Invoice" + type: "string" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoices/search/{searchKey}: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoices/{invoiceId}/auditLogsWithHistory: get: tags: - - "Invoice" - summary: "Search invoices" + - "Invoice" + summary: "Retrieve invoice audit logs with history by id" description: "" - operationId: "searchInvoices" + operationId: "getInvoiceAuditLogsWithHistory" produces: - - "application/json" + - "application/json" parameters: - - name: "searchKey" - in: "path" - required: true - type: "string" - pattern: ".*" - - name: "offset" - in: "query" - required: false - type: "integer" - default: 0 - format: "int64" - - name: "limit" - in: "query" - required: false - type: "integer" - default: 100 - format: "int64" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "invoiceId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" responses: "200": description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/Invoice" + $ref: "#/definitions/AuditLog" + "404": + description: "Invoice not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoices/byNumber/{invoiceNumber}: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoices/byItemId/{itemId}: get: tags: - - "Invoice" - summary: "Retrieve an invoice by number" + - "Invoice" + summary: "Retrieve an invoice by invoice item id" description: "" - operationId: "getInvoiceByNumber" + operationId: "getInvoiceByItemId" produces: - - "application/json" + - "application/json" parameters: - - name: "invoiceNumber" - in: "path" - required: true - type: "integer" - pattern: "[0-9]+" - format: "int32" - - name: "withChildrenItems" - in: "query" - required: false - type: "boolean" - default: false - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "itemId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "withChildrenItems" + in: "query" + required: false + type: "boolean" + default: false + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" @@ -6325,345 +6282,332 @@ paths: "404": description: "Invoice not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoices/{invoiceId}/html: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoices/manualPayTemplate/{locale}: get: tags: - - "Invoice" - summary: "Render an invoice as HTML" + - "Invoice" + summary: "Retrieves the manualPay invoice template for the tenant" description: "" - operationId: "getInvoiceAsHTML" + operationId: "getInvoiceMPTemplate" produces: - - "text/html" + - "text/html" parameters: - - name: "invoiceId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" + - name: "locale" + in: "path" + required: true + type: "string" + pattern: ".*" responses: "200": description: "successful operation" schema: type: "string" "404": - description: "Invoice not found" + description: "Template not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoices/{invoiceId}/commitInvoice: - put: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoices/template: + get: tags: - - "Invoice" - summary: "Perform the invoice status transition from DRAFT to COMMITTED" + - "Invoice" + summary: "Retrieves the invoice template for the tenant" description: "" - operationId: "commitInvoice" - consumes: - - "application/json" + operationId: "getInvoiceTemplate" produces: - - "application/json" - parameters: - - name: "invoiceId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - "text/html" + parameters: [] responses: - "204": - description: "Successful operation" + "200": + description: "successful operation" + schema: + type: "string" "404": - description: "Invoice not found" + description: "Template not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoices/migration/{accountId}: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] post: tags: - - "Invoice" - summary: "Create a migration invoice" + - "Invoice" + summary: "Upload the invoice template for the tenant" description: "" - operationId: "createMigrationInvoice" + operationId: "uploadInvoiceTemplate" consumes: - - "application/json" + - "text/html" produces: - - "application/json" + - "text/html" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - type: "array" - items: - $ref: "#/definitions/InvoiceItem" - - name: "targetDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - in: "body" + name: "body" + required: true + schema: + type: "string" + - name: "deleteIfExists" + in: "query" + required: false + type: "boolean" + default: false + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "201": - description: "Created migration invoice successfully" + description: "Uploaded invoice template Successfully" schema: - $ref: "#/definitions/Invoice" - "400": - description: "Invalid account id or target datetime supplied" + type: "string" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoices/{invoiceId}/voidInvoice: - put: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoices/translation/{locale}: + get: tags: - - "Invoice" - summary: "Perform the action of voiding an invoice" + - "Invoice" + summary: "Retrieves the invoice translation for the tenant" description: "" - operationId: "voidInvoice" - consumes: - - "application/json" + operationId: "getInvoiceTranslation" produces: - - "application/json" + - "text/plain" parameters: - - name: "invoiceId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "locale" + in: "path" + required: true + type: "string" + pattern: ".*" responses: - "204": - description: "Successful operation" + "200": + description: "successful operation" + schema: + type: "string" "400": - description: "Invalid invoice id supplied" + description: "Invalid locale supplied" "404": - description: "Invoice not found" + description: "Translation not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoices/{invoiceId}/{invoiceItemId}/cba: - delete: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + post: tags: - - "Invoice" - summary: "Delete a CBA item" + - "Invoice" + summary: "Upload the invoice translation for the tenant" description: "" - operationId: "deleteCBA" + operationId: "uploadInvoiceTranslation" consumes: - - "application/json" + - "text/plain" produces: - - "application/json" + - "text/plain" parameters: - - name: "invoiceId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "invoiceItemId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "accountId" - in: "query" - required: true - type: "string" - format: "uuid" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "locale" + in: "path" + required: true + type: "string" + pattern: ".*" + - in: "body" + name: "body" + required: true + schema: + type: "string" + - name: "deleteIfExists" + in: "query" + required: false + type: "boolean" + default: false + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: - "204": - description: "Successful operation" - "400": - description: "Invalid account id, invoice id or invoice item id supplied" - "404": - description: "Account or invoice not found" + "201": + description: "Uploaded invoice translation Successfully" + schema: + type: "string" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/nodesInfo: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoices/{groupId}/group: get: tags: - - "NodesInfo" - summary: "Retrieve all the nodes infos" + - "Invoice" + summary: "Retrieve a set of invoices by group id" description: "" - operationId: "getNodesInfo" + operationId: "getInvoicesGroup" produces: - - "application/json" - parameters: [] + - "application/json" + parameters: + - name: "groupId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "accountId" + in: "query" + required: true + type: "string" + format: "uuid" + - name: "withChildrenItems" + in: "query" + required: false + type: "boolean" + default: false + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/NodeInfo" + $ref: "#/definitions/Invoice" + "400": + description: "Invalid group id supplied" security: - - basicAuth: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoices/manualPayTemplate: post: tags: - - "NodesInfo" - summary: "Trigger a node command" + - "Invoice" + summary: "Upload the manualPay invoice template for the tenant" description: "" - operationId: "triggerNodeCommand" + operationId: "uploadInvoiceMPTemplate" consumes: - - "application/json" - produces: - - "application/json" - parameters: - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/NodeCommand" - - name: "localNodeOnly" - in: "query" - required: false - type: "boolean" - default: false - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "202": - description: "Successful operation" - "400": - description: "Invalid node command supplied" + - "text/html" + produces: + - "text/html" + parameters: + - in: "body" + name: "body" + required: true + schema: + type: "string" + - name: "deleteIfExists" + in: "query" + required: false + type: "boolean" + default: false + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "200": + description: "successful operation" + schema: + type: "string" security: - - basicAuth: [] - /1.0/kb/overdue/xml: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/nodesInfo: get: tags: - - "Overdue" - summary: "Retrieve the overdue config as XML" + - "NodesInfo" + summary: "Retrieve all the nodes infos" description: "" - operationId: "getOverdueConfigXml" + operationId: "getNodesInfo" produces: - - "text/xml" + - "application/json" parameters: [] responses: "200": description: "successful operation" schema: - type: "string" + type: "array" + items: + $ref: "#/definitions/NodeInfo" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] post: tags: - - "Overdue" - summary: "Upload the full overdue config as XML" + - "NodesInfo" + summary: "Trigger a node command" description: "" - operationId: "uploadOverdueConfigXml" + operationId: "triggerNodeCommand" consumes: - - "text/xml" + - "application/json" + produces: + - "application/json" parameters: - - in: "body" - name: "body" - required: true - schema: + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/NodeCommand" + - name: "localNodeOnly" + in: "query" + required: false + type: "boolean" + default: false + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: - "201": - description: "Successfully uploaded overdue config" - schema: - type: "string" + "202": + description: "Successful operation" "400": description: "Invalid node command supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] /1.0/kb/overdue: get: tags: - - "Overdue" + - "Overdue" summary: "Retrieve the overdue config as JSON" description: "" operationId: "getOverdueConfigJson" produces: - - "application/json" + - "application/json" parameters: [] responses: "200": @@ -6671,37 +6615,37 @@ paths: schema: $ref: "#/definitions/Overdue" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] post: tags: - - "Overdue" + - "Overdue" summary: "Upload the full overdue config as JSON" description: "" operationId: "uploadOverdueConfigJson" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/Overdue" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/Overdue" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "201": description: "Successfully uploaded overdue config" @@ -6710,117 +6654,119 @@ paths: "400": description: "Invalid node command supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/paymentGateways/hosted/form: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/overdue/xml: + get: + tags: + - "Overdue" + summary: "Retrieve the overdue config as XML" + description: "" + operationId: "getOverdueConfigXml" + produces: + - "text/xml" + parameters: [] + responses: + "200": + description: "successful operation" + schema: + type: "string" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] post: tags: - - "PaymentGateway" - summary: "Combo API to generate form data to redirect the customer to the gateway" + - "Overdue" + summary: "Upload the full overdue config as XML" description: "" - operationId: "buildComboFormDescriptor" + operationId: "uploadOverdueConfigXml" consumes: - - "application/json" - produces: - - "application/json" - parameters: - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/ComboHostedPaymentPage" - - name: "controlPluginName" - in: "query" - required: false - type: "array" - items: + - "text/xml" + parameters: + - in: "body" + name: "body" + required: true + schema: + type: "string" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true type: "string" - collectionFormat: "multi" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: - "200": - description: "successful operation" + "201": + description: "Successfully uploaded overdue config" schema: - $ref: "#/definitions/HostedPaymentPageFormDescriptor" + type: "string" "400": - description: "Invalid data for Account or PaymentMethod" + description: "Invalid node command supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/paymentGateways/hosted/form/{accountId}: post: tags: - - "PaymentGateway" + - "PaymentGateway" summary: "Generate form data to redirect the customer to the gateway" description: "" operationId: "buildFormDescriptor" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/HostedPaymentPageFields" - - name: "paymentMethodId" - in: "query" - required: false - type: "string" - format: "uuid" - - name: "controlPluginName" - in: "query" - required: false - type: "array" - items: + - name: "accountId" + in: "path" + required: true type: "string" - collectionFormat: "multi" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/HostedPaymentPageFields" + - name: "paymentMethodId" + in: "query" + required: false + type: "string" + format: "uuid" + - name: "controlPluginName" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "200": description: "successful operation" @@ -6829,89 +6775,143 @@ paths: "404": description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/paymentGateways/notification/{pluginName}: post: tags: - - "PaymentGateway" + - "PaymentGateway" summary: "Process a gateway notification" description: "The response is built by the appropriate plugin" operationId: "processNotification" consumes: - - "*/*" + - "*/*" produces: - - "application/json" + - "application/json" parameters: - - name: "pluginName" - in: "path" - required: true - type: "string" - pattern: ".*" - - in: "body" - name: "body" - required: true - schema: + - name: "pluginName" + in: "path" + required: true type: "string" - - name: "controlPluginName" - in: "query" - required: false - type: "array" - items: + pattern: ".*" + - in: "body" + name: "body" + required: true + schema: + type: "string" + - name: "controlPluginName" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true type: "string" - collectionFormat: "multi" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "200": description: "Successful" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/paymentGateways/hosted/form: + post: + tags: + - "PaymentGateway" + summary: "Combo API to generate form data to redirect the customer to the gateway" + description: "" + operationId: "buildComboFormDescriptor" + consumes: + - "application/json" + produces: + - "application/json" + parameters: + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/ComboHostedPaymentPage" + - name: "controlPluginName" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "200": + description: "successful operation" + schema: + $ref: "#/definitions/HostedPaymentPageFormDescriptor" + "400": + description: "Invalid data for Account or PaymentMethod" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/paymentMethods/{paymentMethodId}/customFields: get: tags: - - "PaymentMethod" + - "PaymentMethod" summary: "Retrieve payment method custom fields" description: "" operationId: "getPaymentMethodCustomFields" produces: - - "application/json" + - "application/json" parameters: - - name: "paymentMethodId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "paymentMethodId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" @@ -6922,45 +6922,45 @@ paths: "400": description: "Invalid payment method id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] post: tags: - - "PaymentMethod" + - "PaymentMethod" summary: "Add custom fields to payment method" description: "" operationId: "createPaymentMethodCustomFields" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "paymentMethodId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - type: "array" - items: - $ref: "#/definitions/CustomField" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "paymentMethodId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + type: "array" + items: + $ref: "#/definitions/CustomField" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "201": description: "Custom field created successfully" @@ -6971,222 +6971,263 @@ paths: "400": description: "Invalid payment method id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] put: tags: - - "PaymentMethod" + - "PaymentMethod" summary: "Modify custom fields to payment method" description: "" operationId: "modifyPaymentMethodCustomFields" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "paymentMethodId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - type: "array" - items: - $ref: "#/definitions/CustomField" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "paymentMethodId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + type: "array" + items: + $ref: "#/definitions/CustomField" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "204": description: "Successful operation" "400": description: "Invalid payment method id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] delete: tags: - - "PaymentMethod" + - "PaymentMethod" summary: "Remove custom fields from payment method" description: "" operationId: "deletePaymentMethodCustomFields" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "paymentMethodId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "customField" - in: "query" - required: false - type: "array" - items: + - name: "paymentMethodId" + in: "path" + required: true type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "customField" + in: "query" + required: false + type: "array" + items: + type: "string" + format: "uuid" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "204": description: "Successful operation" "400": description: "Invalid payment method id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/paymentMethods/{paymentMethodId}/auditLogsWithHistory: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/paymentMethods/pagination: get: tags: - - "PaymentMethod" - summary: "Retrieve payment method audit logs with history by id" + - "PaymentMethod" + summary: "List payment methods" description: "" - operationId: "getPaymentMethodAuditLogsWithHistory" + operationId: "getPaymentMethods" produces: - - "application/json" - parameters: - - name: "paymentMethodId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" + - "application/json" + parameters: + - name: "offset" + in: "query" + required: false + type: "integer" + default: 0 + format: "int64" + - name: "limit" + in: "query" + required: false + type: "integer" + default: 100 + format: "int64" + - name: "pluginName" + in: "query" + required: false + type: "string" + - name: "withPluginInfo" + in: "query" + required: false + type: "boolean" + default: false + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/AuditLog" - "404": - description: "Account not found" + $ref: "#/definitions/PaymentMethod" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/paymentMethods: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/paymentMethods/search/{searchKey}: get: tags: - - "PaymentMethod" - summary: "Retrieve a payment method by external key" + - "PaymentMethod" + summary: "Search payment methods" description: "" - operationId: "getPaymentMethodByKey" + operationId: "searchPaymentMethods" produces: - - "application/json" - parameters: - - name: "externalKey" - in: "query" - required: true - type: "string" - - name: "includedDeleted" - in: "query" - required: false - type: "boolean" - default: false - - name: "withPluginInfo" - in: "query" - required: false - type: "boolean" - default: false - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - "application/json" + parameters: + - name: "searchKey" + in: "path" + required: true + type: "string" + pattern: ".*" + - name: "offset" + in: "query" + required: false + type: "integer" + default: 0 + format: "int64" + - name: "limit" + in: "query" + required: false + type: "integer" + default: 100 + format: "int64" + - name: "pluginName" + in: "query" + required: false + type: "string" + - name: "withPluginInfo" + in: "query" + required: false + type: "boolean" + default: false + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "audit" + in: "query" + required: false type: "string" - collectionFormat: "multi" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" schema: - $ref: "#/definitions/PaymentMethod" - "404": - description: "Account or payment method not found" + type: "array" + items: + $ref: "#/definitions/PaymentMethod" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/paymentMethods/{paymentMethodId}: get: tags: - - "PaymentMethod" + - "PaymentMethod" summary: "Retrieve a payment method by id" description: "" operationId: "getPaymentMethod" produces: - - "application/json" + - "application/json" parameters: - - name: "paymentMethodId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "includedDeleted" - in: "query" - required: false - type: "boolean" - default: false - - name: "withPluginInfo" - in: "query" - required: false - type: "boolean" - default: false - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "paymentMethodId" + in: "path" + required: true type: "string" - collectionFormat: "multi" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "includedDeleted" + in: "query" + required: false + type: "boolean" + default: false + - name: "withPluginInfo" + in: "query" + required: false + type: "boolean" + default: false + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" @@ -7197,53 +7238,53 @@ paths: "404": description: "Account or payment method not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] delete: tags: - - "PaymentMethod" + - "PaymentMethod" summary: "Delete a payment method" description: "" operationId: "deletePaymentMethod" produces: - - "application/json" + - "application/json" parameters: - - name: "paymentMethodId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "deleteDefaultPmWithAutoPayOff" - in: "query" - required: false - type: "boolean" - default: false - - name: "forceDefaultPmDeletion" - in: "query" - required: false - type: "boolean" - default: false - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "paymentMethodId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "deleteDefaultPmWithAutoPayOff" + in: "query" + required: false + type: "boolean" + default: false + - name: "forceDefaultPmDeletion" + in: "query" + required: false + type: "boolean" + default: false + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "204": description: "Successful operation" @@ -7252,451 +7293,581 @@ paths: "404": description: "Account or payment method not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/paymentMethods/pagination: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/paymentMethods/{paymentMethodId}/auditLogsWithHistory: get: tags: - - "PaymentMethod" - summary: "List payment methods" + - "PaymentMethod" + summary: "Retrieve payment method audit logs with history by id" description: "" - operationId: "getPaymentMethods" + operationId: "getPaymentMethodAuditLogsWithHistory" produces: - - "application/json" + - "application/json" parameters: - - name: "offset" - in: "query" - required: false - type: "integer" - default: 0 - format: "int64" - - name: "limit" - in: "query" - required: false - type: "integer" - default: 100 - format: "int64" - - name: "pluginName" - in: "query" - required: false - type: "string" - - name: "withPluginInfo" - in: "query" - required: false - type: "boolean" - default: false - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "paymentMethodId" + in: "path" + required: true type: "string" - collectionFormat: "multi" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" responses: "200": description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/PaymentMethod" + $ref: "#/definitions/AuditLog" + "404": + description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/paymentMethods/search/{searchKey}: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/paymentMethods: get: tags: - - "PaymentMethod" - summary: "Search payment methods" + - "PaymentMethod" + summary: "Retrieve a payment method by external key" description: "" - operationId: "searchPaymentMethods" + operationId: "getPaymentMethodByKey" + produces: + - "application/json" + parameters: + - name: "externalKey" + in: "query" + required: true + type: "string" + - name: "includedDeleted" + in: "query" + required: false + type: "boolean" + default: false + - name: "withPluginInfo" + in: "query" + required: false + type: "boolean" + default: false + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" + responses: + "200": + description: "successful operation" + schema: + $ref: "#/definitions/PaymentMethod" + "404": + description: "Account or payment method not found" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/payments/{paymentId}/tags: + get: + tags: + - "Payment" + summary: "Retrieve payment payment tags" + description: "" + operationId: "getPaymentTags" produces: - - "application/json" + - "application/json" parameters: - - name: "searchKey" - in: "path" - required: true - type: "string" - pattern: ".*" - - name: "offset" - in: "query" - required: false - type: "integer" - default: 0 - format: "int64" - - name: "limit" - in: "query" - required: false - type: "integer" - default: 100 - format: "int64" - - name: "pluginName" - in: "query" - required: false - type: "string" - - name: "withPluginInfo" - in: "query" - required: false - type: "boolean" - default: false - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "paymentId" + in: "path" + required: true type: "string" - collectionFormat: "multi" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "includedDeleted" + in: "query" + required: false + type: "boolean" + default: false + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/PaymentMethod" + $ref: "#/definitions/Tag" + "400": + description: "Invalid payment id supplied" + "404": + description: "Invoice not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/payments/cancelScheduledPaymentTransaction: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + post: + tags: + - "Payment" + summary: "Add tags to payment payment" + description: "" + operationId: "createPaymentTags" + consumes: + - "application/json" + produces: + - "application/json" + parameters: + - name: "paymentId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + type: "array" + items: + type: "string" + format: "uuid" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "201": + description: "Tag created successfully" + schema: + type: "array" + items: + $ref: "#/definitions/Tag" + "400": + description: "Invalid payment id supplied" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] delete: tags: - - "Payment" - summary: "Cancels a scheduled payment attempt retry" + - "Payment" + summary: "Remove tags from payment payment" description: "" - operationId: "cancelScheduledPaymentTransactionByExternalKey" + operationId: "deletePaymentTags" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "transactionExternalKey" - in: "query" - required: true - type: "string" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "paymentId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "tagDef" + in: "query" + required: false + type: "array" + items: + type: "string" + format: "uuid" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "204": description: "Successful operation" "400": - description: "Invalid paymentTransactionExternalKey supplied" + description: "Invalid payment id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/payments: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/payments/pagination: get: tags: - - "Payment" - summary: "Retrieve a payment by external key" + - "Payment" + summary: "Get payments" description: "" - operationId: "getPaymentByExternalKey" + operationId: "getPayments" + produces: + - "application/json" + parameters: + - name: "offset" + in: "query" + required: false + type: "integer" + default: 0 + format: "int64" + - name: "limit" + in: "query" + required: false + type: "integer" + default: 100 + format: "int64" + - name: "pluginName" + in: "query" + required: false + type: "string" + - name: "withPluginInfo" + in: "query" + required: false + type: "boolean" + default: false + - name: "withAttempts" + in: "query" + required: false + type: "boolean" + default: false + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" + responses: + "200": + description: "successful operation" + schema: + type: "array" + items: + $ref: "#/definitions/Payment" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/payments/{paymentId}/customFields: + get: + tags: + - "Payment" + summary: "Retrieve payment custom fields" + description: "" + operationId: "getPaymentCustomFields" produces: - - "application/json" + - "application/json" parameters: - - name: "withPluginInfo" - in: "query" - required: false - type: "boolean" - default: false - - name: "withAttempts" - in: "query" - required: false - type: "boolean" - default: false - - name: "externalKey" - in: "query" - required: true - type: "string" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "paymentId" + in: "path" + required: true type: "string" - collectionFormat: "multi" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" schema: - $ref: "#/definitions/Payment" - "404": - description: "Payment not found" + type: "array" + items: + $ref: "#/definitions/CustomField" + "400": + description: "Invalid payment id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] post: tags: - - "Payment" - summary: "Capture an existing authorization" + - "Payment" + summary: "Add custom fields to payment" description: "" - operationId: "captureAuthorizationByExternalKey" + operationId: "createPaymentCustomFields" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/PaymentTransaction" - - name: "controlPluginName" - in: "query" - required: false - type: "array" - items: + - name: "paymentId" + in: "path" + required: true type: "string" - collectionFormat: "multi" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + type: "array" + items: + $ref: "#/definitions/CustomField" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "201": - description: "Payment transaction created successfully" + description: "Custom field created successfully" schema: - $ref: "#/definitions/Payment" - "404": - description: "Account or payment not found" - "402": - description: "Transaction declined by gateway" - "422": - description: "Payment is aborted by a control plugin" - "502": - description: "Failed to submit payment transaction" - "503": - description: "Payment in unknown status, failed to receive gateway response" - "504": - description: "Payment operation timeout" + type: "array" + items: + $ref: "#/definitions/CustomField" + "400": + description: "Invalid payment id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] put: tags: - - "Payment" - summary: "Complete an existing transaction" + - "Payment" + summary: "Modify custom fields to payment" description: "" - operationId: "completeTransactionByExternalKey" + operationId: "modifyPaymentCustomFields" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/PaymentTransaction" - - name: "controlPluginName" - in: "query" - required: false - type: "array" - items: + - name: "paymentId" + in: "path" + required: true type: "string" - collectionFormat: "multi" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + type: "array" + items: + $ref: "#/definitions/CustomField" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "204": description: "Successful operation" - "404": - description: "Account or payment not found" - "402": - description: "Transaction declined by gateway" - "422": - description: "Payment is aborted by a control plugin" - "502": - description: "Failed to submit payment transaction" - "503": - description: "Payment in unknown status, failed to receive gateway response" - "504": - description: "Payment operation timeout" + "400": + description: "Invalid payment id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] delete: tags: - - "Payment" - summary: "Void an existing payment" + - "Payment" + summary: "Remove custom fields from payment payment" description: "" - operationId: "voidPaymentByExternalKey" + operationId: "deletePaymentCustomFields" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/PaymentTransaction" - - name: "controlPluginName" - in: "query" - required: false - type: "array" - items: + - name: "paymentId" + in: "path" + required: true type: "string" - collectionFormat: "multi" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "customField" + in: "query" + required: false + type: "array" + items: + type: "string" + format: "uuid" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "204": description: "Successful operation" + "400": + description: "Invalid payment id supplied" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/payments/{paymentId}: + get: + tags: + - "Payment" + summary: "Retrieve a payment by id" + description: "" + operationId: "getPayment" + produces: + - "application/json" + parameters: + - name: "paymentId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "withPluginInfo" + in: "query" + required: false + type: "boolean" + default: false + - name: "withAttempts" + in: "query" + required: false + type: "boolean" + default: false + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" + responses: + "200": + description: "successful operation" + schema: + $ref: "#/definitions/Payment" + "400": + description: "Invalid paymentId supplied" "404": - description: "Account or payment not found" - "402": - description: "Transaction declined by gateway" - "422": - description: "Payment is aborted by a control plugin" - "502": - description: "Failed to submit payment transaction" - "503": - description: "Payment in unknown status, failed to receive gateway response" - "504": - description: "Payment operation timeout" + description: "Payment not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/payments/chargebacks: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] post: tags: - - "Payment" - summary: "Record a chargeback" + - "Payment" + summary: "Capture an existing authorization" description: "" - operationId: "chargebackPaymentByExternalKey" + operationId: "captureAuthorization" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/PaymentTransaction" - - name: "controlPluginName" - in: "query" - required: false - type: "array" - items: + - name: "paymentId" + in: "path" + required: true type: "string" - collectionFormat: "multi" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/PaymentTransaction" + - name: "controlPluginName" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "201": description: "Payment transaction created successfully" schema: $ref: "#/definitions/Payment" + "400": + description: "Invalid paymentId supplied" "404": description: "Account or payment not found" "402": @@ -7710,57 +7881,62 @@ paths: "504": description: "Payment operation timeout" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/payments/chargebackReversals: - post: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + put: tags: - - "Payment" - summary: "Record a chargeback reversal" + - "Payment" + summary: "Complete an existing transaction" description: "" - operationId: "chargebackReversalPaymentByExternalKey" + operationId: "completeTransaction" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/PaymentTransaction" - - name: "controlPluginName" - in: "query" - required: false - type: "array" - items: + - name: "paymentId" + in: "path" + required: true type: "string" - collectionFormat: "multi" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/PaymentTransaction" + - name: "controlPluginName" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: - "201": - description: "Payment transaction created successfully" - schema: - $ref: "#/definitions/Payment" + "204": + description: "Successful operation" + "400": + description: "Invalid paymentId supplied" "404": description: "Account or payment not found" "402": @@ -7774,350 +7950,507 @@ paths: "504": description: "Payment operation timeout" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/payments/{paymentTransactionId}/cancelScheduledPaymentTransaction: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] delete: tags: - - "Payment" - summary: "Cancels a scheduled payment attempt retry" + - "Payment" + summary: "Void an existing payment" description: "" - operationId: "cancelScheduledPaymentTransactionById" + operationId: "voidPayment" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "paymentTransactionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "paymentId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/PaymentTransaction" + - name: "controlPluginName" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "204": description: "Successful operation" "400": - description: "Invalid paymentTransactionId supplied" + description: "Invalid paymentId supplied" + "404": + description: "Account or payment not found" + "402": + description: "Transaction declined by gateway" + "422": + description: "Payment is aborted by a control plugin" + "502": + description: "Failed to submit payment transaction" + "503": + description: "Payment in unknown status, failed to receive gateway response" + "504": + description: "Payment operation timeout" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/payments/{paymentId}/auditLogsWithHistory: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/payments: get: tags: - - "Payment" - summary: "Retrieve payment audit logs with history by id" + - "Payment" + summary: "Retrieve a payment by external key" description: "" - operationId: "getPaymentAuditLogsWithHistory" + operationId: "getPaymentByExternalKey" produces: - - "application/json" - parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" + - "application/json" + parameters: + - name: "withPluginInfo" + in: "query" + required: false + type: "boolean" + default: false + - name: "withAttempts" + in: "query" + required: false + type: "boolean" + default: false + - name: "externalKey" + in: "query" + required: true + type: "string" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" schema: - type: "array" - items: - $ref: "#/definitions/AuditLog" + $ref: "#/definitions/Payment" "404": - description: "Account not found" + description: "Payment not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/payments/attempts/{paymentAttemptId}/auditLogsWithHistory: - get: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + post: tags: - - "Payment" - summary: "Retrieve payment attempt audit logs with history by id" + - "Payment" + summary: "Capture an existing authorization" description: "" - operationId: "getPaymentAttemptAuditLogsWithHistory" + operationId: "captureAuthorizationByExternalKey" + consumes: + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "paymentAttemptId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/PaymentTransaction" + - name: "controlPluginName" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: - "200": - description: "successful operation" + "201": + description: "Payment transaction created successfully" schema: - type: "array" - items: - $ref: "#/definitions/AuditLog" + $ref: "#/definitions/Payment" "404": - description: "Account not found" + description: "Account or payment not found" + "402": + description: "Transaction declined by gateway" + "422": + description: "Payment is aborted by a control plugin" + "502": + description: "Failed to submit payment transaction" + "503": + description: "Payment in unknown status, failed to receive gateway response" + "504": + description: "Payment operation timeout" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/payments/{paymentId}/tags: - get: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + put: tags: - - "Payment" - summary: "Retrieve payment payment tags" + - "Payment" + summary: "Complete an existing transaction" description: "" - operationId: "getPaymentTags" + operationId: "completeTransactionByExternalKey" + consumes: + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "includedDeleted" - in: "query" - required: false - type: "boolean" - default: false - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" - responses: - "200": - description: "successful operation" + - in: "body" + name: "body" + required: true schema: - type: "array" - items: - $ref: "#/definitions/Tag" - "400": - description: "Invalid payment id supplied" + $ref: "#/definitions/PaymentTransaction" + - name: "controlPluginName" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "204": + description: "Successful operation" "404": - description: "Invoice not found" + description: "Account or payment not found" + "402": + description: "Transaction declined by gateway" + "422": + description: "Payment is aborted by a control plugin" + "502": + description: "Failed to submit payment transaction" + "503": + description: "Payment in unknown status, failed to receive gateway response" + "504": + description: "Payment operation timeout" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - post: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + delete: tags: - - "Payment" - summary: "Add tags to payment payment" + - "Payment" + summary: "Void an existing payment" description: "" - operationId: "createPaymentTags" + operationId: "voidPaymentByExternalKey" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/PaymentTransaction" + - name: "controlPluginName" + in: "query" + required: false type: "array" items: type: "string" - format: "uuid" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + collectionFormat: "multi" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: - "201": - description: "Tag created successfully" + "204": + description: "Successful operation" + "404": + description: "Account or payment not found" + "402": + description: "Transaction declined by gateway" + "422": + description: "Payment is aborted by a control plugin" + "502": + description: "Failed to submit payment transaction" + "503": + description: "Payment in unknown status, failed to receive gateway response" + "504": + description: "Payment operation timeout" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/payments/search/{searchKey}: + get: + tags: + - "Payment" + summary: "Search payments" + description: "" + operationId: "searchPayments" + produces: + - "application/json" + parameters: + - name: "searchKey" + in: "path" + required: true + type: "string" + pattern: ".*" + - name: "offset" + in: "query" + required: false + type: "integer" + default: 0 + format: "int64" + - name: "limit" + in: "query" + required: false + type: "integer" + default: 100 + format: "int64" + - name: "withPluginInfo" + in: "query" + required: false + type: "boolean" + default: false + - name: "withAttempts" + in: "query" + required: false + type: "boolean" + default: false + - name: "pluginName" + in: "query" + required: false + type: "string" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" + responses: + "200": + description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/Tag" - "400": - description: "Invalid payment id supplied" + $ref: "#/definitions/Payment" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/payments/cancelScheduledPaymentTransaction: delete: tags: - - "Payment" - summary: "Remove tags from payment payment" + - "Payment" + summary: "Cancels a scheduled payment attempt retry" description: "" - operationId: "deletePaymentTags" + operationId: "cancelScheduledPaymentTransactionByExternalKey" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "tagDef" - in: "query" - required: false - type: "array" - items: + - name: "transactionExternalKey" + in: "query" + required: true + type: "string" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - format: "uuid" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "204": description: "Successful operation" "400": - description: "Invalid payment id supplied" + description: "Invalid paymentTransactionExternalKey supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/payments/{paymentId}: - get: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/payments/{paymentTransactionId}/cancelScheduledPaymentTransaction: + delete: tags: - - "Payment" - summary: "Retrieve a payment by id" + - "Payment" + summary: "Cancels a scheduled payment attempt retry" description: "" - operationId: "getPayment" + operationId: "cancelScheduledPaymentTransactionById" + consumes: + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "withPluginInfo" - in: "query" - required: false - type: "boolean" - default: false - - name: "withAttempts" - in: "query" - required: false - type: "boolean" - default: false - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "paymentTransactionId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" responses: - "200": - description: "successful operation" - schema: - $ref: "#/definitions/Payment" + "204": + description: "Successful operation" "400": - description: "Invalid paymentId supplied" - "404": - description: "Payment not found" + description: "Invalid paymentTransactionId supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/payments/{paymentId}/chargebacks: post: tags: - - "Payment" - summary: "Capture an existing authorization" + - "Payment" + summary: "Record a chargeback" description: "" - operationId: "captureAuthorization" + operationId: "chargebackPayment" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/PaymentTransaction" - - name: "controlPluginName" - in: "query" - required: false - type: "array" - items: + - name: "paymentId" + in: "path" + required: true type: "string" - collectionFormat: "multi" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/PaymentTransaction" + - name: "controlPluginName" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "201": description: "Payment transaction created successfully" @@ -8138,62 +8471,57 @@ paths: "504": description: "Payment operation timeout" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - put: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/payments/chargebacks: + post: tags: - - "Payment" - summary: "Complete an existing transaction" + - "Payment" + summary: "Record a chargeback" description: "" - operationId: "completeTransaction" + operationId: "chargebackPaymentByExternalKey" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/PaymentTransaction" - - name: "controlPluginName" - in: "query" - required: false - type: "array" - items: + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/PaymentTransaction" + - name: "controlPluginName" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true type: "string" - collectionFormat: "multi" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: - "204": - description: "Successful operation" - "400": - description: "Invalid paymentId supplied" + "201": + description: "Payment transaction created successfully" + schema: + $ref: "#/definitions/Payment" "404": description: "Account or payment not found" "402": @@ -8207,60 +8535,63 @@ paths: "504": description: "Payment operation timeout" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - delete: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/payments/{paymentId}/chargebackReversals: + post: tags: - - "Payment" - summary: "Void an existing payment" + - "Payment" + summary: "Record a chargeback reversal" description: "" - operationId: "voidPayment" + operationId: "chargebackReversalPayment" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/PaymentTransaction" - - name: "controlPluginName" - in: "query" - required: false - type: "array" - items: + - name: "paymentId" + in: "path" + required: true type: "string" - collectionFormat: "multi" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/PaymentTransaction" + - name: "controlPluginName" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: - "204": - description: "Successful operation" + "201": + description: "Payment transaction created successfully" + schema: + $ref: "#/definitions/Payment" "400": description: "Invalid paymentId supplied" "404": @@ -8276,52 +8607,52 @@ paths: "504": description: "Payment operation timeout" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/payments/refunds: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/payments/chargebackReversals: post: tags: - - "Payment" - summary: "Refund an existing payment" + - "Payment" + summary: "Record a chargeback reversal" description: "" - operationId: "refundPaymentByExternalKey" + operationId: "chargebackReversalPaymentByExternalKey" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/PaymentTransaction" - - name: "controlPluginName" - in: "query" - required: false - type: "array" - items: + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/PaymentTransaction" + - name: "controlPluginName" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true type: "string" - collectionFormat: "multi" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "201": description: "Payment transaction created successfully" @@ -8340,67 +8671,53 @@ paths: "504": description: "Payment operation timeout" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/payments/{paymentId}/chargebacks: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/payments/combo: post: tags: - - "Payment" - summary: "Record a chargeback" + - "Payment" + summary: "Combo api to create a new payment transaction on a existing (or not)\ + \ account " description: "" - operationId: "chargebackPayment" + operationId: "createComboPayment" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/PaymentTransaction" - - name: "controlPluginName" - in: "query" - required: false - type: "array" - items: + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/ComboPaymentTransaction" + - name: "controlPluginName" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true type: "string" - collectionFormat: "multi" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "201": description: "Payment transaction created successfully" schema: $ref: "#/definitions/Payment" "400": - description: "Invalid paymentId supplied" - "404": - description: "Account or payment not found" + description: "Invalid data for Account or PaymentMethod" "402": description: "Transaction declined by gateway" "422": @@ -8412,436 +8729,187 @@ paths: "504": description: "Payment operation timeout" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/payments/{paymentId}/chargebackReversals: - post: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/payments/attempts/{paymentAttemptId}/auditLogsWithHistory: + get: tags: - - "Payment" - summary: "Record a chargeback reversal" + - "Payment" + summary: "Retrieve payment attempt audit logs with history by id" description: "" - operationId: "chargebackReversalPayment" - consumes: - - "application/json" + operationId: "getPaymentAttemptAuditLogsWithHistory" produces: - - "application/json" + - "application/json" parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/PaymentTransaction" - - name: "controlPluginName" - in: "query" - required: false - type: "array" - items: - type: "string" - collectionFormat: "multi" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "paymentAttemptId" + in: "path" + required: true type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" responses: - "201": - description: "Payment transaction created successfully" + "200": + description: "successful operation" schema: - $ref: "#/definitions/Payment" - "400": - description: "Invalid paymentId supplied" + type: "array" + items: + $ref: "#/definitions/AuditLog" "404": - description: "Account or payment not found" - "402": - description: "Transaction declined by gateway" - "422": - description: "Payment is aborted by a control plugin" - "502": - description: "Failed to submit payment transaction" - "503": - description: "Payment in unknown status, failed to receive gateway response" - "504": - description: "Payment operation timeout" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/payments/combo: - post: - tags: - - "Payment" - summary: "Combo api to create a new payment transaction on a existing (or not)\ - \ account " - description: "" - operationId: "createComboPayment" - consumes: - - "application/json" - produces: - - "application/json" - parameters: - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/ComboPaymentTransaction" - - name: "controlPluginName" - in: "query" - required: false - type: "array" - items: - type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "201": - description: "Payment transaction created successfully" - schema: - $ref: "#/definitions/Payment" - "400": - description: "Invalid data for Account or PaymentMethod" - "402": - description: "Transaction declined by gateway" - "422": - description: "Payment is aborted by a control plugin" - "502": - description: "Failed to submit payment transaction" - "503": - description: "Payment in unknown status, failed to receive gateway response" - "504": - description: "Payment operation timeout" + description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/payments/{paymentId}/customFields: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/payments/{paymentId}/auditLogsWithHistory: get: tags: - - "Payment" - summary: "Retrieve payment custom fields" + - "Payment" + summary: "Retrieve payment audit logs with history by id" description: "" - operationId: "getPaymentCustomFields" + operationId: "getPaymentAuditLogsWithHistory" produces: - - "application/json" + - "application/json" parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "paymentId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" responses: "200": description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/CustomField" - "400": - description: "Invalid payment id supplied" + $ref: "#/definitions/AuditLog" + "404": + description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/payments/{paymentId}/refunds: post: tags: - - "Payment" - summary: "Add custom fields to payment" + - "Payment" + summary: "Refund an existing payment" description: "" - operationId: "createPaymentCustomFields" + operationId: "refundPayment" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: + - name: "paymentId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/PaymentTransaction" + - name: "controlPluginName" + in: "query" + required: false type: "array" items: - $ref: "#/definitions/CustomField" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "201": - description: "Custom field created successfully" - schema: - type: "array" - items: - $ref: "#/definitions/CustomField" - "400": - description: "Invalid payment id supplied" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - put: - tags: - - "Payment" - summary: "Modify custom fields to payment" - description: "" - operationId: "modifyPaymentCustomFields" - consumes: - - "application/json" - produces: - - "application/json" - parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: + type: "string" + collectionFormat: "multi" + - name: "pluginProperty" + in: "query" + required: false type: "array" items: - $ref: "#/definitions/CustomField" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "204": - description: "Successful operation" - "400": - description: "Invalid payment id supplied" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - delete: - tags: - - "Payment" - summary: "Remove custom fields from payment payment" - description: "" - operationId: "deletePaymentCustomFields" - consumes: - - "application/json" - produces: - - "application/json" - parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "customField" - in: "query" - required: false - type: "array" - items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true type: "string" - format: "uuid" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "204": - description: "Successful operation" - "400": - description: "Invalid payment id supplied" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/payments/pagination: - get: - tags: - - "Payment" - summary: "Get payments" - description: "" - operationId: "getPayments" - produces: - - "application/json" - parameters: - - name: "offset" - in: "query" - required: false - type: "integer" - default: 0 - format: "int64" - - name: "limit" - in: "query" - required: false - type: "integer" - default: 100 - format: "int64" - - name: "pluginName" - in: "query" - required: false - type: "string" - - name: "withPluginInfo" - in: "query" - required: false - type: "boolean" - default: false - - name: "withAttempts" - in: "query" - required: false - type: "boolean" - default: false - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" responses: - "200": - description: "successful operation" + "201": + description: "Payment transaction created successfully" schema: - type: "array" - items: - $ref: "#/definitions/Payment" + $ref: "#/definitions/Payment" + "400": + description: "Invalid paymentId supplied" + "404": + description: "Account or payment not found" + "402": + description: "Transaction declined by gateway" + "422": + description: "Payment is aborted by a control plugin" + "502": + description: "Failed to submit payment transaction" + "503": + description: "Payment in unknown status, failed to receive gateway response" + "504": + description: "Payment operation timeout" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/payments/{paymentId}/refunds: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/payments/refunds: post: tags: - - "Payment" + - "Payment" summary: "Refund an existing payment" description: "" - operationId: "refundPayment" + operationId: "refundPaymentByExternalKey" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/PaymentTransaction" - - name: "controlPluginName" - in: "query" - required: false - type: "array" - items: + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/PaymentTransaction" + - name: "controlPluginName" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true type: "string" - collectionFormat: "multi" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "201": description: "Payment transaction created successfully" schema: $ref: "#/definitions/Payment" - "400": - description: "Invalid paymentId supplied" "404": description: "Account or payment not found" "402": @@ -8855,86 +8923,18 @@ paths: "504": description: "Payment operation timeout" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/payments/search/{searchKey}: - get: - tags: - - "Payment" - summary: "Search payments" - description: "" - operationId: "searchPayments" - produces: - - "application/json" - parameters: - - name: "searchKey" - in: "path" - required: true - type: "string" - pattern: ".*" - - name: "offset" - in: "query" - required: false - type: "integer" - default: 0 - format: "int64" - - name: "limit" - in: "query" - required: false - type: "integer" - default: 100 - format: "int64" - - name: "withPluginInfo" - in: "query" - required: false - type: "boolean" - default: false - - name: "withAttempts" - in: "query" - required: false - type: "boolean" - default: false - - name: "pluginName" - in: "query" - required: false - type: "string" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: - type: "string" - collectionFormat: "multi" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" - responses: - "200": - description: "successful operation" - schema: - type: "array" - items: - $ref: "#/definitions/Payment" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/pluginsInfo: get: tags: - - "PluginInfo" + - "PluginInfo" summary: "Retrieve the list of registered plugins" description: "" operationId: "getPluginsInfo" produces: - - "application/json" + - "application/json" parameters: [] responses: "200": @@ -8944,35 +8944,18 @@ paths: items: $ref: "#/definitions/PluginInfo" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/security/subject: - get: - tags: - - "Security" - summary: "Get user information" - description: "" - operationId: "getCurrentUserSubject" - produces: - - "application/json" - parameters: [] - responses: - "200": - description: "successful operation" - schema: - $ref: "#/definitions/Subject" - security: - - basicAuth: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/security/permissions: get: tags: - - "Security" + - "Security" summary: "List user permissions" description: "" operationId: "getCurrentUserPermissions" produces: - - "application/json" + - "application/json" parameters: [] responses: "200": @@ -8982,97 +8965,97 @@ paths: items: type: "string" security: - - basicAuth: [] + - basicAuth: [] /1.0/kb/security/users: post: tags: - - "Security" + - "Security" summary: "Add a new user with roles (to make api requests)" description: "" operationId: "addUserRoles" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/UserRoles" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/UserRoles" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "201": description: "User role created successfully" schema: $ref: "#/definitions/UserRoles" security: - - basicAuth: [] + - basicAuth: [] /1.0/kb/security/users/{username}/password: put: tags: - - "Security" + - "Security" summary: "Update a user password" description: "" operationId: "updateUserPassword" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "username" - in: "path" - required: true - type: "string" - pattern: ".*" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/UserRoles" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "204": - description: "Successful operation" + - name: "username" + in: "path" + required: true + type: "string" + pattern: ".*" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/UserRoles" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "204": + description: "Successful operation" security: - - basicAuth: [] + - basicAuth: [] /1.0/kb/security/users/{username}/roles: get: tags: - - "Security" + - "Security" summary: "Get roles associated to a user" description: "" operationId: "getUserRoles" produces: - - "application/json" + - "application/json" parameters: - - name: "username" - in: "path" - required: true - type: "string" - pattern: ".*" + - name: "username" + in: "path" + required: true + type: "string" + pattern: ".*" responses: "200": description: "successful operation" @@ -9081,481 +9064,347 @@ paths: "404": description: "The user does not exist or has been inactivated" security: - - basicAuth: [] + - basicAuth: [] put: tags: - - "Security" + - "Security" summary: "Update roles associated to a user" description: "" operationId: "updateUserRoles" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "username" - in: "path" - required: true - type: "string" - pattern: ".*" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/UserRoles" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "username" + in: "path" + required: true + type: "string" + pattern: ".*" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/UserRoles" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "204": description: "Successful operation" security: - - basicAuth: [] + - basicAuth: [] /1.0/kb/security/users/{username}: delete: tags: - - "Security" + - "Security" summary: "Invalidate an existing user" description: "" operationId: "invalidateUser" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "username" - in: "path" - required: true - type: "string" - pattern: ".*" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "username" + in: "path" + required: true + type: "string" + pattern: ".*" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "204": description: "Successful operation" security: - - basicAuth: [] + - basicAuth: [] /1.0/kb/security/roles: post: tags: - - "Security" + - "Security" summary: "Add a new role definition)" description: "" operationId: "addRoleDefinition" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/RoleDefinition" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/RoleDefinition" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "201": description: "Role definition created successfully" schema: $ref: "#/definitions/RoleDefinition" security: - - basicAuth: [] + - basicAuth: [] put: tags: - - "Security" + - "Security" summary: "Update a new role definition)" description: "" operationId: "updateRoleDefinition" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/RoleDefinition" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/RoleDefinition" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "204": description: "Successful operation" security: - - basicAuth: [] + - basicAuth: [] /1.0/kb/security/roles/{role}: get: tags: - - "Security" + - "Security" summary: "Get role definition" description: "" operationId: "getRoleDefinition" produces: - - "application/json" + - "application/json" parameters: - - name: "role" - in: "path" - required: true - type: "string" - pattern: ".*" + - name: "role" + in: "path" + required: true + type: "string" + pattern: ".*" responses: "200": description: "successful operation" schema: $ref: "#/definitions/RoleDefinition" security: - - basicAuth: [] - /1.0/kb/subscriptions/{subscriptionId}/auditLogsWithHistory: + - basicAuth: [] + /1.0/kb/security/subject: get: tags: - - "Subscription" - summary: "Retrieve subscription audit logs with history by id" + - "Security" + summary: "Get user information" description: "" - operationId: "getSubscriptionAuditLogsWithHistory" + operationId: "getCurrentUserSubject" produces: - - "application/json" - parameters: - - name: "subscriptionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" + - "application/json" + parameters: [] responses: "200": description: "successful operation" schema: - type: "array" - items: - $ref: "#/definitions/AuditLog" - "404": - description: "Subscription not found" + $ref: "#/definitions/Subject" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/subscriptions/events/{eventId}/auditLogsWithHistory: + - basicAuth: [] + /1.0/kb/subscriptions/{subscriptionId}/tags: get: tags: - - "Subscription" - summary: "Retrieve subscription event audit logs with history by id" + - "Subscription" + summary: "Retrieve subscription tags" description: "" - operationId: "getSubscriptionEventAuditLogsWithHistory" + operationId: "getSubscriptionTags" produces: - - "application/json" + - "application/json" parameters: - - name: "eventId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" + - name: "subscriptionId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "includedDeleted" + in: "query" + required: false + type: "boolean" + default: false + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/AuditLog" + $ref: "#/definitions/Tag" + "400": + description: "Invalid subscription id supplied" "404": - description: "Subscription event not found" + description: "Subscription not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/subscriptions/createSubscriptionWithAddOns: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] post: tags: - - "Subscription" - summary: "Create an entitlement with addOn products" - description: "" - operationId: "createSubscriptionWithAddOns" + - "Subscription" + operationId: "createSubscriptionTags" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - in: "body" - name: "body" - required: true - schema: - type: "array" - items: - $ref: "#/definitions/Subscription" - - name: "entitlementDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "billingDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "migrated" - in: "query" - required: false - type: "boolean" - default: false - - name: "skipResponse" - in: "query" - required: false - type: "boolean" - default: false - - name: "renameKeyIfExistsAndUnused" - in: "query" - required: false - type: "boolean" - default: true - - name: "callCompletion" - in: "query" - required: false - type: "boolean" - default: false - - name: "callTimeoutSec" - in: "query" - required: false - type: "integer" - default: 3 - format: "int64" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "subscriptionId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + type: "array" + items: + type: "string" + format: "uuid" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "201": - description: "Subscriptions created successfully" - schema: - $ref: "#/definitions/Bundle" + description: "Tag created successfully" + "400": + description: "Invalid subscription id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/subscriptions/createSubscriptionsWithAddOns: - post: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + delete: tags: - - "Subscription" - summary: "Create multiple entitlements with addOn products" + - "Subscription" + summary: "Remove tags from subscription" description: "" - operationId: "createSubscriptionsWithAddOns" + operationId: "deleteSubscriptionTags" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - in: "body" - name: "body" - required: true - schema: + - name: "subscriptionId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "tagDef" + in: "query" + required: false type: "array" items: - $ref: "#/definitions/BulkSubscriptionsBundle" - - name: "entitlementDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "billingDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "renameKeyIfExistsAndUnused" - in: "query" - required: false - type: "boolean" - default: true - - name: "migrated" - in: "query" - required: false - type: "boolean" - default: false - - name: "skipResponse" - in: "query" - required: false - type: "boolean" - default: false - - name: "callCompletion" - in: "query" - required: false - type: "boolean" - default: false - - name: "callTimeoutSec" - in: "query" - required: false - type: "integer" - default: 3 - format: "int64" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + type: "string" + format: "uuid" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "201": - description: "Subscriptions created successfully" - schema: - type: "array" - items: - $ref: "#/definitions/Bundle" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/subscriptions/{subscriptionId}/block: - post: - tags: - - "Subscription" - summary: "Block a subscription" - description: "" - operationId: "addSubscriptionBlockingState" - consumes: - - "application/json" - parameters: - - name: "subscriptionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/BlockingState" - - name: "requestedDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: - "201": - description: "Blocking state created successfully" - schema: - type: "array" - items: - $ref: "#/definitions/BlockingState" + "204": + description: "Successful operation" "400": description: "Invalid subscription id supplied" - "404": - description: "Subscription not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/subscriptions/{subscriptionId}/customFields: get: tags: - - "Subscription" + - "Subscription" summary: "Retrieve subscription custom fields" description: "" operationId: "getSubscriptionCustomFields" produces: - - "application/json" + - "application/json" parameters: - - name: "subscriptionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "subscriptionId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" @@ -9566,305 +9415,230 @@ paths: "400": description: "Invalid subscription id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] post: tags: - - "Subscription" + - "Subscription" summary: "Add custom fields to subscription" description: "" operationId: "createSubscriptionCustomFields" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "subscriptionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - type: "array" - items: - $ref: "#/definitions/CustomField" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "subscriptionId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + type: "array" + items: + $ref: "#/definitions/CustomField" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "201": description: "Custom field created successfully" "400": description: "Invalid subscription id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] put: tags: - - "Subscription" + - "Subscription" summary: "Modify custom fields to subscription" description: "" operationId: "modifySubscriptionCustomFields" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "subscriptionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - type: "array" - items: - $ref: "#/definitions/CustomField" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "subscriptionId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + type: "array" + items: + $ref: "#/definitions/CustomField" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "204": description: "Successful operation" "400": description: "Invalid subscription id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] delete: tags: - - "Subscription" + - "Subscription" summary: "Remove custom fields from subscription" description: "" operationId: "deleteSubscriptionCustomFields" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "subscriptionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "customField" - in: "query" - required: false - type: "array" - items: + - name: "subscriptionId" + in: "path" + required: true type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "customField" + in: "query" + required: false + type: "array" + items: + type: "string" + format: "uuid" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "204": description: "Successful operation" "400": description: "Invalid subscription id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/subscriptions/{subscriptionId}/tags: - get: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/subscriptions/{subscriptionId}/block: + post: tags: - - "Subscription" - summary: "Retrieve subscription tags" + - "Subscription" + summary: "Block a subscription" description: "" - operationId: "getSubscriptionTags" - produces: - - "application/json" + operationId: "addSubscriptionBlockingState" + consumes: + - "application/json" parameters: - - name: "subscriptionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "includedDeleted" - in: "query" - required: false - type: "boolean" - default: false - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "subscriptionId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/BlockingState" + - name: "requestedDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: - "200": - description: "successful operation" + "201": + description: "Blocking state created successfully" schema: type: "array" items: - $ref: "#/definitions/Tag" + $ref: "#/definitions/BlockingState" "400": description: "Invalid subscription id supplied" "404": description: "Subscription not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - post: - tags: - - "Subscription" - operationId: "createSubscriptionTags" - consumes: - - "application/json" - produces: - - "application/json" - parameters: - - name: "subscriptionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - type: "array" - items: - type: "string" - format: "uuid" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "201": - description: "Tag created successfully" - "400": - description: "Invalid subscription id supplied" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - delete: - tags: - - "Subscription" - summary: "Remove tags from subscription" - description: "" - operationId: "deleteSubscriptionTags" - consumes: - - "application/json" - produces: - - "application/json" - parameters: - - name: "subscriptionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "tagDef" - in: "query" - required: false - type: "array" - items: - type: "string" - format: "uuid" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "204": - description: "Successful operation" - "400": - description: "Invalid subscription id supplied" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/subscriptions/{subscriptionId}: get: tags: - - "Subscription" + - "Subscription" summary: "Retrieve a subscription by id" description: "" operationId: "getSubscription" produces: - - "application/json" + - "application/json" parameters: - - name: "subscriptionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "subscriptionId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" @@ -9875,75 +9649,75 @@ paths: "404": description: "Subscription not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] put: tags: - - "Subscription" + - "Subscription" summary: "Change entitlement plan" description: "" operationId: "changeSubscriptionPlan" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "subscriptionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/Subscription" - - name: "requestedDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "callCompletion" - in: "query" - required: false - type: "boolean" - default: false - - name: "callTimeoutSec" - in: "query" - required: false - type: "integer" - default: 3 - format: "int64" - - name: "billingPolicy" - in: "query" - required: false - type: "string" - enum: - - "START_OF_TERM" - - "END_OF_TERM" - - "IMMEDIATE" - - "ILLEGAL" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "subscriptionId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/Subscription" + - name: "requestedDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "callCompletion" + in: "query" + required: false + type: "boolean" + default: false + - name: "callTimeoutSec" + in: "query" + required: false + type: "integer" + default: 3 + format: "int64" + - name: "billingPolicy" + in: "query" + required: false + type: "string" + enum: + - "START_OF_TERM" + - "END_OF_TERM" + - "IMMEDIATE" + - "ILLEGAL" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "204": description: "Successful operation" @@ -9952,80 +9726,80 @@ paths: "404": description: "Entitlement not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] delete: tags: - - "Subscription" + - "Subscription" summary: "Cancel an entitlement plan" description: "" operationId: "cancelSubscriptionPlan" produces: - - "application/json" + - "application/json" parameters: - - name: "subscriptionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "requestedDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "callCompletion" - in: "query" - required: false - type: "boolean" - default: false - - name: "callTimeoutSec" - in: "query" - required: false - type: "integer" - default: 5 - format: "int64" - - name: "entitlementPolicy" - in: "query" - required: false - type: "string" - enum: - - "IMMEDIATE" - - "END_OF_TERM" - - name: "billingPolicy" - in: "query" - required: false - type: "string" - enum: - - "START_OF_TERM" - - "END_OF_TERM" - - "IMMEDIATE" - - "ILLEGAL" - - name: "useRequestedDateForBilling" - in: "query" - required: false - type: "boolean" - default: false - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "subscriptionId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "requestedDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "callCompletion" + in: "query" + required: false + type: "boolean" + default: false + - name: "callTimeoutSec" + in: "query" + required: false + type: "integer" + default: 5 + format: "int64" + - name: "entitlementPolicy" + in: "query" + required: false + type: "string" + enum: + - "IMMEDIATE" + - "END_OF_TERM" + - name: "billingPolicy" + in: "query" + required: false + type: "string" + enum: + - "START_OF_TERM" + - "END_OF_TERM" + - "IMMEDIATE" + - "ILLEGAL" + - name: "useRequestedDateForBilling" + in: "query" + required: false + type: "boolean" + default: false + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "204": description: "Successful operation" @@ -10034,140 +9808,32 @@ paths: "404": description: "Entitlement not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/subscriptions/{subscriptionId}/quantity: - put: - tags: - - "Subscription" - summary: "Update the quantity associated to a subscription" - description: "" - operationId: "updateSubscriptionQuantity" - consumes: - - "application/json" - produces: - - "application/json" - parameters: - - name: "subscriptionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/Subscription" - - name: "effectiveFromDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "forceNewQuantityWithPastEffectiveDate" - in: "query" - required: false - type: "boolean" - default: false - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "204": - description: "Successful operation" - "400": - description: "Invalid entitlement supplied" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/subscriptions/{subscriptionId}/bcd: - put: - tags: - - "Subscription" - summary: "Update the BCD associated to a subscription" - description: "" - operationId: "updateSubscriptionBCD" - consumes: - - "application/json" - produces: - - "application/json" - parameters: - - name: "subscriptionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/Subscription" - - name: "effectiveFromDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "forceNewBcdWithPastEffectiveDate" - in: "query" - required: false - type: "boolean" - default: false - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "204": - description: "Successful operation" - "400": - description: "Invalid entitlement supplied" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/subscriptions: get: tags: - - "Subscription" + - "Subscription" summary: "Retrieve a subscription by external key" description: "" operationId: "getSubscriptionByKey" produces: - - "application/json" + - "application/json" parameters: - - name: "externalKey" - in: "query" - required: true - type: "string" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "externalKey" + in: "query" + required: true + type: "string" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" @@ -10176,197 +9842,273 @@ paths: "404": description: "Subscription not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] post: tags: - - "Subscription" + - "Subscription" summary: "Create an subscription" description: "" operationId: "createSubscription" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/Subscription" - - name: "entitlementDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "billingDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "renameKeyIfExistsAndUnused" - in: "query" - required: false - type: "boolean" - default: true - - name: "migrated" - in: "query" - required: false - type: "boolean" - default: false - - name: "skipResponse" - in: "query" - required: false - type: "boolean" - default: false - - name: "callCompletion" - in: "query" - required: false - type: "boolean" - default: false - - name: "callTimeoutSec" - in: "query" - required: false - type: "integer" - default: 3 - format: "int64" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/Subscription" + - name: "entitlementDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "billingDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "renameKeyIfExistsAndUnused" + in: "query" + required: false + type: "boolean" + default: true + - name: "migrated" + in: "query" + required: false + type: "boolean" + default: false + - name: "skipResponse" + in: "query" + required: false + type: "boolean" + default: false + - name: "callCompletion" + in: "query" + required: false + type: "boolean" + default: false + - name: "callTimeoutSec" + in: "query" + required: false + type: "integer" + default: 3 + format: "int64" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "201": description: "Subscription created successfully" schema: $ref: "#/definitions/Subscription" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/subscriptions/{subscriptionId}/uncancel: - put: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/subscriptions/createSubscriptionWithAddOns: + post: tags: - - "Subscription" - summary: "Un-cancel an entitlement" + - "Subscription" + summary: "Create an entitlement with addOn products" description: "" - operationId: "uncancelSubscriptionPlan" + operationId: "createSubscriptionWithAddOns" + consumes: + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "subscriptionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - in: "body" + name: "body" + required: true + schema: + type: "array" + items: + $ref: "#/definitions/Subscription" + - name: "entitlementDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "billingDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "migrated" + in: "query" + required: false + type: "boolean" + default: false + - name: "skipResponse" + in: "query" + required: false + type: "boolean" + default: false + - name: "renameKeyIfExistsAndUnused" + in: "query" + required: false + type: "boolean" + default: true + - name: "callCompletion" + in: "query" + required: false + type: "boolean" + default: false + - name: "callTimeoutSec" + in: "query" + required: false + type: "integer" + default: 3 + format: "int64" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: - "204": - description: "Successful operation" - "400": - description: "Invalid subscription id supplied" - "404": - description: "Entitlement not found" + "201": + description: "Subscriptions created successfully" + schema: + $ref: "#/definitions/Bundle" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/subscriptions/{subscriptionId}/undoChangePlan: - put: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/subscriptions/createSubscriptionsWithAddOns: + post: tags: - - "Subscription" - summary: "Undo a pending change plan on an entitlement" + - "Subscription" + summary: "Create multiple entitlements with addOn products" description: "" - operationId: "undoChangeSubscriptionPlan" + operationId: "createSubscriptionsWithAddOns" + consumes: + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "subscriptionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - in: "body" + name: "body" + required: true + schema: + type: "array" + items: + $ref: "#/definitions/BulkSubscriptionsBundle" + - name: "entitlementDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "billingDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "renameKeyIfExistsAndUnused" + in: "query" + required: false + type: "boolean" + default: true + - name: "migrated" + in: "query" + required: false + type: "boolean" + default: false + - name: "skipResponse" + in: "query" + required: false + type: "boolean" + default: false + - name: "callCompletion" + in: "query" + required: false + type: "boolean" + default: false + - name: "callTimeoutSec" + in: "query" + required: false + type: "integer" + default: 3 + format: "int64" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: - "204": - description: "Successful operation" - "400": - description: "Invalid subscription id supplied" - "404": - description: "Entitlement not found" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/tagDefinitions/{tagDefinitionId}/auditLogsWithHistory: - get: + "201": + description: "Subscriptions created successfully" + schema: + type: "array" + items: + $ref: "#/definitions/Bundle" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/subscriptions/{subscriptionId}/auditLogsWithHistory: + get: tags: - - "TagDefinition" - summary: "Retrieve tag definition audit logs with history by id" + - "Subscription" + summary: "Retrieve subscription audit logs with history by id" description: "" - operationId: "getTagDefinitionAuditLogsWithHistory" + operationId: "getSubscriptionAuditLogsWithHistory" produces: - - "application/json" + - "application/json" parameters: - - name: "tagDefinitionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" + - name: "subscriptionId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" responses: "200": description: "successful operation" @@ -10375,30 +10117,259 @@ paths: items: $ref: "#/definitions/AuditLog" "404": - description: "Account not found" + description: "Subscription not found" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/subscriptions/events/{eventId}/auditLogsWithHistory: + get: + tags: + - "Subscription" + summary: "Retrieve subscription event audit logs with history by id" + description: "" + operationId: "getSubscriptionEventAuditLogsWithHistory" + produces: + - "application/json" + parameters: + - name: "eventId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + responses: + "200": + description: "successful operation" + schema: + type: "array" + items: + $ref: "#/definitions/AuditLog" + "404": + description: "Subscription event not found" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/subscriptions/{subscriptionId}/uncancel: + put: + tags: + - "Subscription" + summary: "Un-cancel an entitlement" + description: "" + operationId: "uncancelSubscriptionPlan" + produces: + - "application/json" + parameters: + - name: "subscriptionId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "204": + description: "Successful operation" + "400": + description: "Invalid subscription id supplied" + "404": + description: "Entitlement not found" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/subscriptions/{subscriptionId}/undoChangePlan: + put: + tags: + - "Subscription" + summary: "Undo a pending change plan on an entitlement" + description: "" + operationId: "undoChangeSubscriptionPlan" + produces: + - "application/json" + parameters: + - name: "subscriptionId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "204": + description: "Successful operation" + "400": + description: "Invalid subscription id supplied" + "404": + description: "Entitlement not found" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/subscriptions/{subscriptionId}/bcd: + put: + tags: + - "Subscription" + summary: "Update the BCD associated to a subscription" + description: "" + operationId: "updateSubscriptionBCD" + consumes: + - "application/json" + produces: + - "application/json" + parameters: + - name: "subscriptionId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/Subscription" + - name: "effectiveFromDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "forceNewBcdWithPastEffectiveDate" + in: "query" + required: false + type: "boolean" + default: false + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "204": + description: "Successful operation" + "400": + description: "Invalid entitlement supplied" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/subscriptions/{subscriptionId}/quantity: + put: + tags: + - "Subscription" + summary: "Update the quantity associated to a subscription" + description: "" + operationId: "updateSubscriptionQuantity" + consumes: + - "application/json" + produces: + - "application/json" + parameters: + - name: "subscriptionId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/Subscription" + - name: "effectiveFromDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "forceNewQuantityWithPastEffectiveDate" + in: "query" + required: false + type: "boolean" + default: false + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "204": + description: "Successful operation" + "400": + description: "Invalid entitlement supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/tagDefinitions: get: tags: - - "TagDefinition" + - "TagDefinition" summary: "List tag definitions" description: "" operationId: "getTagDefinitions" produces: - - "application/json" + - "application/json" parameters: - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" @@ -10407,37 +10378,37 @@ paths: items: $ref: "#/definitions/TagDefinition" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] post: tags: - - "TagDefinition" + - "TagDefinition" summary: "Create a tag definition" description: "" operationId: "createTagDefinition" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/TagDefinition" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/TagDefinition" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "201": description: "Tag definition created successfully" @@ -10446,34 +10417,34 @@ paths: "400": description: "Invalid name or description supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/tagDefinitions/{tagDefinitionId}: get: tags: - - "TagDefinition" + - "TagDefinition" summary: "Retrieve a tag definition" description: "" operationId: "getTagDefinition" produces: - - "application/json" + - "application/json" parameters: - - name: "tagDefinitionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "tagDefinitionId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" @@ -10482,76 +10453,152 @@ paths: "400": description: "Invalid tagDefinitionId supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] delete: tags: - - "TagDefinition" + - "TagDefinition" summary: "Delete a tag definition" description: "" operationId: "deleteTagDefinition" produces: - - "application/json" + - "application/json" parameters: - - name: "tagDefinitionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "tagDefinitionId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "204": description: "Successful operation" "400": description: "Invalid tagDefinitionId supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/tagDefinitions/{tagDefinitionId}/auditLogsWithHistory: + get: + tags: + - "TagDefinition" + summary: "Retrieve tag definition audit logs with history by id" + description: "" + operationId: "getTagDefinitionAuditLogsWithHistory" + produces: + - "application/json" + parameters: + - name: "tagDefinitionId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + responses: + "200": + description: "successful operation" + schema: + type: "array" + items: + $ref: "#/definitions/AuditLog" + "404": + description: "Account not found" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/tags/pagination: get: tags: - - "Tag" + - "Tag" summary: "List tags" description: "" operationId: "getTags" produces: - - "application/json" - parameters: - - name: "offset" - in: "query" - required: false - type: "integer" - default: 0 - format: "int64" - - name: "limit" - in: "query" - required: false - type: "integer" - default: 100 - format: "int64" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - "application/json" + parameters: + - name: "offset" + in: "query" + required: false + type: "integer" + default: 0 + format: "int64" + - name: "limit" + in: "query" + required: false + type: "integer" + default: 100 + format: "int64" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" + responses: + "200": + description: "successful operation" + schema: + type: "array" + items: + $ref: "#/definitions/Tag" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/tags/search/{searchKey}: + get: + tags: + - "Tag" + summary: "Search tags" + description: "" + operationId: "searchTags" + produces: + - "application/json" + parameters: + - name: "searchKey" + in: "path" + required: true + type: "string" + pattern: ".*" + - name: "offset" + in: "query" + required: false + type: "integer" + default: 0 + format: "int64" + - name: "limit" + in: "query" + required: false + type: "integer" + default: 100 + format: "int64" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" @@ -10560,25 +10607,25 @@ paths: items: $ref: "#/definitions/Tag" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/tags/{tagId}/auditLogsWithHistory: get: tags: - - "Tag" + - "Tag" summary: "Retrieve tag audit logs with history by id" description: "" operationId: "getTagAuditLogsWithHistory" produces: - - "application/json" + - "application/json" parameters: - - name: "tagId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" + - name: "tagId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" responses: "200": description: "successful operation" @@ -10589,71 +10636,89 @@ paths: "404": description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/tags/search/{searchKey}: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/tenants: get: tags: - - "Tag" - summary: "Search tags" + - "Tenant" + summary: "Retrieve a tenant by its API key" description: "" - operationId: "searchTags" + operationId: "getTenantByApiKey" produces: - - "application/json" + - "application/json" parameters: - - name: "searchKey" - in: "path" - required: true - type: "string" - pattern: ".*" - - name: "offset" - in: "query" - required: false - type: "integer" - default: 0 - format: "int64" - - name: "limit" - in: "query" - required: false - type: "integer" - default: 100 - format: "int64" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "apiKey" + in: "query" + required: false + type: "string" responses: "200": description: "successful operation" schema: - type: "array" - items: - $ref: "#/definitions/Tag" + $ref: "#/definitions/Tenant" + "404": + description: "Tenant not found" + security: + - basicAuth: [] + post: + tags: + - "Tenant" + summary: "Create a tenant" + description: "" + operationId: "createTenant" + consumes: + - "application/json" + produces: + - "application/json" + parameters: + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/Tenant" + - name: "useGlobalDefault" + in: "query" + required: false + type: "boolean" + default: false + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "201": + description: "Tenant created successfully" + schema: + $ref: "#/definitions/Tenant" + "409": + description: "Tenant already exists" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] /1.0/kb/tenants/uploadPluginPaymentStateMachineConfig/{pluginName}: get: tags: - - "Tenant" + - "Tenant" summary: "Retrieve a per tenant payment state machine for a plugin" description: "" operationId: "getPluginPaymentStateMachineConfig" produces: - - "application/json" + - "application/json" parameters: - - name: "pluginName" - in: "path" - required: true - type: "string" - pattern: ".*" + - name: "pluginName" + in: "path" + required: true + type: "string" + pattern: ".*" responses: "200": description: "successful operation" @@ -10662,42 +10727,42 @@ paths: "400": description: "Invalid tenantId supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] post: tags: - - "Tenant" + - "Tenant" summary: "Add a per tenant payment state machine for a plugin" description: "" operationId: "uploadPluginPaymentStateMachineConfig" consumes: - - "text/plain" + - "text/plain" produces: - - "application/json" + - "application/json" parameters: - - name: "pluginName" - in: "path" - required: true - type: "string" - pattern: ".*" - - in: "body" - name: "body" - required: true - schema: + - name: "pluginName" + in: "path" + required: true + type: "string" + pattern: ".*" + - in: "body" + name: "body" + required: true + schema: + type: "string" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "201": description: "Per tenant state machine uploaded successfully" @@ -10706,51 +10771,51 @@ paths: "400": description: "Invalid tenantId supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] delete: tags: - - "Tenant" + - "Tenant" summary: "Delete a per tenant payment state machine for a plugin" description: "" operationId: "deletePluginPaymentStateMachineConfig" parameters: - - name: "pluginName" - in: "path" - required: true - type: "string" - pattern: ".*" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "pluginName" + in: "path" + required: true + type: "string" + pattern: ".*" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "204": description: "Successful operation" "400": description: "Invalid tenantId supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/tenants/registerNotificationCallback: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/tenants/uploadPerTenantConfig: get: tags: - - "Tenant" - summary: "Retrieve a push notification" + - "Tenant" + summary: "Retrieve a per tenant configuration (system properties)" description: "" - operationId: "getPushNotificationCallbacks" + operationId: "getPerTenantConfiguration" produces: - - "application/json" + - "application/json" parameters: [] responses: "200": @@ -10760,85 +10825,91 @@ paths: "400": description: "Invalid tenantId supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] post: tags: - - "Tenant" - summary: "Create a push notification" + - "Tenant" + summary: "Add a per tenant configuration (system properties)" description: "" - operationId: "registerPushNotificationCallback" + operationId: "uploadPerTenantConfiguration" consumes: - - "application/json" + - "text/plain" produces: - - "application/json" + - "application/json" parameters: - - name: "cb" - in: "query" - required: false - type: "string" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - in: "body" + name: "body" + required: true + schema: + type: "string" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "201": - description: "Push notification registered successfully" + description: "Per tenant configuration uploaded successfully" schema: $ref: "#/definitions/TenantKeyValue" "400": description: "Invalid tenantId supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] delete: tags: - - "Tenant" - summary: "Delete a push notification" + - "Tenant" + summary: "Delete a per tenant configuration (system properties)" description: "" - operationId: "deletePushNotificationCallbacks" + operationId: "deletePerTenantConfiguration" parameters: - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "204": description: "Successful operation" "400": description: "Invalid tenantId supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/tenants/uploadPerTenantConfig: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/tenants/uploadPluginConfig/{pluginName}: get: tags: - - "Tenant" - summary: "Retrieve a per tenant configuration (system properties)" + - "Tenant" + summary: "Retrieve a per tenant configuration for a plugin" description: "" - operationId: "getPerTenantConfiguration" + operationId: "getPluginConfiguration" produces: - - "application/json" - parameters: [] + - "application/json" + parameters: + - name: "pluginName" + in: "path" + required: true + type: "string" + pattern: ".*" responses: "200": description: "successful operation" @@ -10847,91 +10918,96 @@ paths: "400": description: "Invalid tenantId supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] post: tags: - - "Tenant" - summary: "Add a per tenant configuration (system properties)" + - "Tenant" + summary: "Add a per tenant configuration for a plugin" description: "" - operationId: "uploadPerTenantConfiguration" + operationId: "uploadPluginConfiguration" consumes: - - "text/plain" + - "text/plain" produces: - - "application/json" + - "application/json" parameters: - - in: "body" - name: "body" - required: true - schema: + - name: "pluginName" + in: "path" + required: true + type: "string" + pattern: ".*" + - in: "body" + name: "body" + required: true + schema: + type: "string" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "201": - description: "Per tenant configuration uploaded successfully" + description: "Plugin configuration uploaded successfully" schema: $ref: "#/definitions/TenantKeyValue" "400": description: "Invalid tenantId supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] delete: tags: - - "Tenant" - summary: "Delete a per tenant configuration (system properties)" + - "Tenant" + summary: "Delete a per tenant configuration for a plugin" description: "" - operationId: "deletePerTenantConfiguration" + operationId: "deletePluginConfiguration" parameters: - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "pluginName" + in: "path" + required: true + type: "string" + pattern: ".*" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "204": description: "Successful operation" "400": description: "Invalid tenantId supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/tenants/uploadPluginConfig/{pluginName}: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/tenants/registerNotificationCallback: get: tags: - - "Tenant" - summary: "Retrieve a per tenant configuration for a plugin" + - "Tenant" + summary: "Retrieve a push notification" description: "" - operationId: "getPluginConfiguration" + operationId: "getPushNotificationCallbacks" produces: - - "application/json" - parameters: - - name: "pluginName" - in: "path" - required: true - type: "string" - pattern: ".*" + - "application/json" + parameters: [] responses: "200": description: "successful operation" @@ -10940,129 +11016,90 @@ paths: "400": description: "Invalid tenantId supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] post: tags: - - "Tenant" - summary: "Add a per tenant configuration for a plugin" + - "Tenant" + summary: "Create a push notification" description: "" - operationId: "uploadPluginConfiguration" + operationId: "registerPushNotificationCallback" consumes: - - "text/plain" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "pluginName" - in: "path" - required: true - type: "string" - pattern: ".*" - - in: "body" - name: "body" - required: true - schema: + - name: "cb" + in: "query" + required: false + type: "string" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "201": - description: "Plugin configuration uploaded successfully" + description: "Push notification registered successfully" schema: $ref: "#/definitions/TenantKeyValue" "400": description: "Invalid tenantId supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] delete: tags: - - "Tenant" - summary: "Delete a per tenant configuration for a plugin" + - "Tenant" + summary: "Delete a push notification" description: "" - operationId: "deletePluginConfiguration" + operationId: "deletePushNotificationCallbacks" parameters: - - name: "pluginName" - in: "path" - required: true - type: "string" - pattern: ".*" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "204": description: "Successful operation" "400": description: "Invalid tenantId supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/tenants/uploadPerTenantConfig/{keyPrefix}/search: - get: - tags: - - "Tenant" - summary: "Retrieve a per tenant key value based on key prefix" - description: "" - operationId: "getAllPluginConfiguration" - produces: - - "application/json" - parameters: - - name: "keyPrefix" - in: "path" - required: true - type: "string" - pattern: ".*" - responses: - "200": - description: "successful operation" - schema: - type: "array" - items: - $ref: "#/definitions/TenantKeyValue" - "400": - description: "Invalid tenantId supplied" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/tenants/userKeyValue/{keyName}: get: tags: - - "Tenant" + - "Tenant" summary: "Retrieve a per tenant user key/value" description: "" operationId: "getUserKeyValue" produces: - - "application/json" + - "application/json" parameters: - - name: "keyName" - in: "path" - required: true - type: "string" - pattern: ".*" + - name: "keyName" + in: "path" + required: true + type: "string" + pattern: ".*" responses: "200": description: "successful operation" @@ -11071,42 +11108,42 @@ paths: "400": description: "Invalid tenantId supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] post: tags: - - "Tenant" + - "Tenant" summary: "Add a per tenant user key/value" description: "" operationId: "insertUserKeyValue" consumes: - - "text/plain" + - "text/plain" produces: - - "application/json" + - "application/json" parameters: - - name: "keyName" - in: "path" - required: true - type: "string" - pattern: ".*" - - in: "body" - name: "body" - required: true - schema: + - name: "keyName" + in: "path" + required: true + type: "string" + pattern: ".*" + - in: "body" + name: "body" + required: true + schema: + type: "string" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "201": description: "Per tenant config uploaded successfully" @@ -11115,123 +11152,86 @@ paths: "400": description: "Invalid tenantId supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] delete: tags: - - "Tenant" + - "Tenant" summary: "Delete a per tenant user key/value" description: "" operationId: "deleteUserKeyValue" parameters: - - name: "keyName" - in: "path" - required: true - type: "string" - pattern: ".*" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "keyName" + in: "path" + required: true + type: "string" + pattern: ".*" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "204": description: "Successful operation" "400": description: "Invalid tenantId supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/tenants: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/tenants/uploadPerTenantConfig/{keyPrefix}/search: get: tags: - - "Tenant" - summary: "Retrieve a tenant by its API key" + - "Tenant" + summary: "Retrieve a per tenant key value based on key prefix" description: "" - operationId: "getTenantByApiKey" + operationId: "getAllPluginConfiguration" produces: - - "application/json" + - "application/json" parameters: - - name: "apiKey" - in: "query" - required: false - type: "string" + - name: "keyPrefix" + in: "path" + required: true + type: "string" + pattern: ".*" responses: "200": description: "successful operation" schema: - $ref: "#/definitions/Tenant" - "404": - description: "Tenant not found" - security: - - basicAuth: [] - post: - tags: - - "Tenant" - summary: "Create a tenant" - description: "" - operationId: "createTenant" - consumes: - - "application/json" - produces: - - "application/json" - parameters: - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/Tenant" - - name: "useGlobalDefault" - in: "query" - required: false - type: "boolean" - default: false - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "201": - description: "Tenant created successfully" - schema: - $ref: "#/definitions/Tenant" - "409": - description: "Tenant already exists" + type: "array" + items: + $ref: "#/definitions/TenantKeyValue" + "400": + description: "Invalid tenantId supplied" security: - - basicAuth: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/tenants/{tenantId}: get: tags: - - "Tenant" + - "Tenant" summary: "Retrieve a tenant by id" description: "" operationId: "getTenant" produces: - - "application/json" + - "application/json" parameters: - - name: "tenantId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" + - name: "tenantId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" responses: "200": description: "successful operation" @@ -11242,450 +11242,370 @@ paths: "404": description: "Tenant not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/paymentTransactions/{transactionId}/customFields: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/paymentTransactions/{transactionId}/tags: get: tags: - - "PaymentTransaction" - summary: "Retrieve payment transaction custom fields" + - "PaymentTransaction" + summary: "Retrieve payment transaction tags" description: "" - operationId: "getTransactionCustomFields" + operationId: "getTransactionTags" produces: - - "application/json" + - "application/json" parameters: - - name: "transactionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + - name: "transactionId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "includedDeleted" + in: "query" + required: false + type: "boolean" + default: false + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/CustomField" + $ref: "#/definitions/Tag" "400": description: "Invalid transaction id supplied" + "404": + description: "Invoice not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] post: tags: - - "PaymentTransaction" - summary: "Add custom fields to payment transaction" + - "PaymentTransaction" + summary: "Add tags to payment transaction" description: "" - operationId: "createTransactionCustomFields" + operationId: "createTransactionTags" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "transactionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - type: "array" - items: - $ref: "#/definitions/CustomField" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "transactionId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + type: "array" + items: + type: "string" + format: "uuid" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "201": - description: "Custom field created successfully" + description: "Tag created successfully" schema: type: "array" items: - $ref: "#/definitions/CustomField" + $ref: "#/definitions/Tag" "400": description: "Invalid transaction id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - put: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + delete: tags: - - "PaymentTransaction" - summary: "Modify custom fields to payment transaction" + - "PaymentTransaction" + summary: "Remove tags from payment transaction" description: "" - operationId: "modifyTransactionCustomFields" + operationId: "deleteTransactionTags" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "transactionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: + - name: "transactionId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "tagDef" + in: "query" + required: false type: "array" items: - $ref: "#/definitions/CustomField" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + type: "string" + format: "uuid" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "204": description: "Successful operation" "400": description: "Invalid transaction id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - delete: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/paymentTransactions/{transactionId}/customFields: + get: tags: - - "PaymentTransaction" - summary: "Remove custom fields from payment transaction" + - "PaymentTransaction" + summary: "Retrieve payment transaction custom fields" description: "" - operationId: "deleteTransactionCustomFields" - consumes: - - "application/json" + operationId: "getTransactionCustomFields" produces: - - "application/json" + - "application/json" parameters: - - name: "transactionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "customField" - in: "query" - required: false - type: "array" - items: + - name: "transactionId" + in: "path" + required: true type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "204": - description: "Successful operation" - "400": - description: "Invalid transaction id supplied" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/paymentTransactions/{transactionId}/auditLogsWithHistory: - get: - tags: - - "PaymentTransaction" - summary: "Retrieve payment transaction audit logs with history by id" - description: "" - operationId: "getTransactionAuditLogsWithHistory" - produces: - - "application/json" - parameters: - - name: "transactionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/AuditLog" - "404": - description: "Account not found" + $ref: "#/definitions/CustomField" + "400": + description: "Invalid transaction id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/paymentTransactions: - get: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + post: tags: - - "PaymentTransaction" - summary: "Retrieve a payment by transaction external key" + - "PaymentTransaction" + summary: "Add custom fields to payment transaction" description: "" - operationId: "getPaymentByTransactionExternalKey" + operationId: "createTransactionCustomFields" + consumes: + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "transactionExternalKey" - in: "query" - required: true - type: "string" - - name: "withPluginInfo" - in: "query" - required: false - type: "boolean" - default: false - - name: "withAttempts" - in: "query" - required: false - type: "boolean" - default: false - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "transactionId" + in: "path" + required: true type: "string" - collectionFormat: "multi" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" - responses: - "200": - description: "successful operation" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true schema: - $ref: "#/definitions/Payment" - "404": - description: "Payment not found" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/paymentTransactions/{transactionId}/tags: - get: - tags: - - "PaymentTransaction" - summary: "Retrieve payment transaction tags" - description: "" - operationId: "getTransactionTags" - produces: - - "application/json" - parameters: - - name: "transactionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "includedDeleted" - in: "query" - required: false - type: "boolean" - default: false - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + type: "array" + items: + $ref: "#/definitions/CustomField" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: - "200": - description: "successful operation" + "201": + description: "Custom field created successfully" schema: type: "array" items: - $ref: "#/definitions/Tag" + $ref: "#/definitions/CustomField" "400": description: "Invalid transaction id supplied" - "404": - description: "Invoice not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - post: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + put: tags: - - "PaymentTransaction" - summary: "Add tags to payment transaction" + - "PaymentTransaction" + summary: "Modify custom fields to payment transaction" description: "" - operationId: "createTransactionTags" + operationId: "modifyTransactionCustomFields" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "transactionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - type: "array" - items: - type: "string" - format: "uuid" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "201": - description: "Tag created successfully" + - name: "transactionId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true schema: type: "array" items: - $ref: "#/definitions/Tag" + $ref: "#/definitions/CustomField" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "204": + description: "Successful operation" "400": description: "Invalid transaction id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] delete: tags: - - "PaymentTransaction" - summary: "Remove tags from payment transaction" + - "PaymentTransaction" + summary: "Remove custom fields from payment transaction" description: "" - operationId: "deleteTransactionTags" + operationId: "deleteTransactionCustomFields" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "transactionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "tagDef" - in: "query" - required: false - type: "array" - items: + - name: "transactionId" + in: "path" + required: true type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "customField" + in: "query" + required: false + type: "array" + items: + type: "string" + format: "uuid" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: "204": description: "Successful operation" "400": description: "Invalid transaction id supplied" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/paymentTransactions/{transactionId}: get: tags: - - "PaymentTransaction" + - "PaymentTransaction" summary: "Retrieve a payment by transaction id" description: "" operationId: "getPaymentByTransactionId" produces: - - "application/json" + - "application/json" parameters: - - name: "transactionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "withPluginInfo" - in: "query" - required: false - type: "boolean" - default: false - - name: "withAttempts" - in: "query" - required: false - type: "boolean" - default: false - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "transactionId" + in: "path" + required: true type: "string" - collectionFormat: "multi" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "withPluginInfo" + in: "query" + required: false + type: "boolean" + default: false + - name: "withAttempts" + in: "query" + required: false + type: "boolean" + default: false + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" @@ -11694,50 +11614,50 @@ paths: "404": description: "Payment not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] post: tags: - - "PaymentTransaction" + - "PaymentTransaction" summary: "Mark a pending payment transaction as succeeded or failed" description: "" operationId: "notifyStateChanged" consumes: - - "application/json" + - "application/json" produces: - - "application/json" + - "application/json" parameters: - - name: "transactionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/PaymentTransaction" - - name: "controlPluginName" - in: "query" - required: false - type: "array" - items: + - name: "transactionId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/PaymentTransaction" + - name: "controlPluginName" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: "201": description: "Successfully notifiy state change" @@ -11748,128 +11668,170 @@ paths: "404": description: "Account or Payment not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/usages/{subscriptionId}/{unitType}: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/paymentTransactions: get: tags: - - "Usage" - summary: "Retrieve usage for a subscription and unit type" + - "PaymentTransaction" + summary: "Retrieve a payment by transaction external key" description: "" - operationId: "getUsage" + operationId: "getPaymentByTransactionExternalKey" + produces: + - "application/json" + parameters: + - name: "transactionExternalKey" + in: "query" + required: true + type: "string" + - name: "withPluginInfo" + in: "query" + required: false + type: "boolean" + default: false + - name: "withAttempts" + in: "query" + required: false + type: "boolean" + default: false + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" + responses: + "200": + description: "successful operation" + schema: + $ref: "#/definitions/Payment" + "404": + description: "Payment not found" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/paymentTransactions/{transactionId}/auditLogsWithHistory: + get: + tags: + - "PaymentTransaction" + summary: "Retrieve payment transaction audit logs with history by id" + description: "" + operationId: "getTransactionAuditLogsWithHistory" produces: - - "application/json" + - "application/json" parameters: - - name: "subscriptionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "unitType" - in: "path" - required: true - type: "string" - - name: "startDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "endDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "transactionId" + in: "path" + required: true type: "string" - collectionFormat: "multi" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" responses: "200": description: "successful operation" schema: - $ref: "#/definitions/RolledUpUsage" - "400": - description: "Missing start date or end date" + type: "array" + items: + $ref: "#/definitions/AuditLog" + "404": + description: "Account not found" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/usages: - post: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/usages/{subscriptionId}/{unitType}: + get: tags: - - "Usage" - summary: "Record usage for a subscription" + - "Usage" + summary: "Retrieve usage for a subscription and unit type" description: "" - operationId: "recordUsage" - consumes: - - "application/json" + operationId: "getUsage" produces: - - "application/json" + - "application/json" parameters: - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/SubscriptionUsageRecord" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + - name: "subscriptionId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "unitType" + in: "path" + required: true + type: "string" + - name: "startDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "endDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" responses: "200": - description: "Successfully recorded usage data change" + description: "successful operation" + schema: + $ref: "#/definitions/RolledUpUsage" "400": - description: "Invalid subscription (e.g. inactive)" + description: "Missing start date or end date" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/usages/{subscriptionId}: get: tags: - - "Usage" + - "Usage" summary: "Retrieve usage for a subscription" description: "" operationId: "getAllUsage" produces: - - "application/json" + - "application/json" parameters: - - name: "subscriptionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "startDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "endDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: + - name: "subscriptionId" + in: "path" + required: true type: "string" - collectionFormat: "multi" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "startDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "endDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" responses: "200": description: "successful operation" @@ -11878,9 +11840,47 @@ paths: "400": description: "Missing start date or end date" security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/usages: + post: + tags: + - "Usage" + summary: "Record usage for a subscription" + description: "" + operationId: "recordUsage" + consumes: + - "application/json" + produces: + - "application/json" + parameters: + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/SubscriptionUsageRecord" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "200": + description: "Successfully recorded usage data change" + "400": + description: "Invalid subscription (e.g. inactive)" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] securityDefinitions: basicAuth: type: "basic" @@ -11904,27 +11904,27 @@ definitions: objectType: type: "string" enum: - - "ACCOUNT" - - "ACCOUNT_EMAIL" - - "BLOCKING_STATES" - - "BUNDLE" - - "CUSTOM_FIELD" - - "INVOICE" - - "PAYMENT" - - "TRANSACTION" - - "INVOICE_ITEM" - - "INVOICE_PAYMENT" - - "SUBSCRIPTION" - - "SUBSCRIPTION_EVENT" - - "SERVICE_BROADCAST" - - "PAYMENT_ATTEMPT" - - "PAYMENT_METHOD" - - "TAG" - - "TAG_DEFINITION" - - "TENANT" - - "TENANT_KVS" - objectId: - type: "string" + - "ACCOUNT" + - "ACCOUNT_EMAIL" + - "BLOCKING_STATES" + - "BUNDLE" + - "CUSTOM_FIELD" + - "INVOICE" + - "PAYMENT" + - "TRANSACTION" + - "INVOICE_ITEM" + - "INVOICE_PAYMENT" + - "SUBSCRIPTION" + - "SUBSCRIPTION_EVENT" + - "SERVICE_BROADCAST" + - "PAYMENT_ATTEMPT" + - "PAYMENT_METHOD" + - "TAG" + - "TAG_DEFINITION" + - "TENANT" + - "TENANT_KVS" + objectId: + type: "string" format: "uuid" changedBy: type: "string" @@ -11939,1607 +11939,1448 @@ definitions: Entity: type: "object" properties: - id: - type: "string" - format: "uuid" createdDate: type: "string" format: "date-time" updatedDate: type: "string" format: "date-time" - Invoice: - type: "object" - properties: - amount: - type: "number" - currency: - type: "string" - enum: - - "AED" - - "AFN" - - "ALL" - - "AMD" - - "ANG" - - "AOA" - - "ARS" - - "AUD" - - "AWG" - - "AZN" - - "BAM" - - "BBD" - - "BDT" - - "BGN" - - "BHD" - - "BIF" - - "BMD" - - "BND" - - "BOB" - - "BRL" - - "BSD" - - "BTN" - - "BWP" - - "BYR" - - "BZD" - - "CAD" - - "CDF" - - "CHF" - - "CLP" - - "CNY" - - "COP" - - "CRC" - - "CUC" - - "CUP" - - "CVE" - - "CZK" - - "DJF" - - "DKK" - - "DOP" - - "DZD" - - "EGP" - - "ERN" - - "ETB" - - "EUR" - - "FJD" - - "FKP" - - "GBP" - - "GEL" - - "GGP" - - "GHS" - - "GIP" - - "GMD" - - "GNF" - - "GTQ" - - "GYD" - - "HKD" - - "HNL" - - "HRK" - - "HTG" - - "HUF" - - "IDR" - - "ILS" - - "IMP" - - "INR" - - "IQD" - - "IRR" - - "ISK" - - "JEP" - - "JMD" - - "JOD" - - "JPY" - - "KES" - - "KGS" - - "KHR" - - "KMF" - - "KPW" - - "KRW" - - "KWD" - - "KYD" - - "KZT" - - "LAK" - - "LBP" - - "LKR" - - "LRD" - - "LSL" - - "LTL" - - "LVL" - - "LYD" - - "MAD" - - "MDL" - - "MGA" - - "MKD" - - "MMK" - - "MNT" - - "MOP" - - "MRO" - - "MUR" - - "MVR" - - "MWK" - - "MXN" - - "MYR" - - "MZN" - - "NAD" - - "NGN" - - "NIO" - - "NOK" - - "NPR" - - "NZD" - - "OMR" - - "PAB" - - "PEN" - - "PGK" - - "PHP" - - "PKR" - - "PLN" - - "PYG" - - "QAR" - - "RON" - - "RSD" - - "RUB" - - "RWF" - - "SAR" - - "SBD" - - "SCR" - - "SDG" - - "SEK" - - "SGD" - - "SHP" - - "SLL" - - "SOS" - - "SPL" - - "SRD" - - "STD" - - "SVC" - - "SYP" - - "SZL" - - "THB" - - "TJS" - - "TMT" - - "TND" - - "TOP" - - "TRY" - - "TTD" - - "TVD" - - "TWD" - - "TZS" - - "UAH" - - "UGX" - - "USD" - - "UYU" - - "UZS" - - "VEF" - - "VND" - - "VUV" - - "WST" - - "XAF" - - "XCD" - - "XDR" - - "XOF" - - "XPF" - - "YER" - - "ZAR" - - "ZMW" - - "ZWD" - - "BTC" - status: - type: "string" - enum: - - "DRAFT" - - "COMMITTED" - - "VOID" - creditAdj: - type: "number" - refundAdj: - type: "number" - invoiceId: - type: "string" - format: "uuid" - invoiceDate: - type: "string" - format: "date" - targetDate: - type: "string" - format: "date" - invoiceNumber: - type: "string" - balance: - type: "number" - accountId: - type: "string" - format: "uuid" - bundleKeys: - type: "string" - credits: - type: "array" - items: - $ref: "#/definitions/InvoiceItem" - items: - type: "array" - items: - $ref: "#/definitions/InvoiceItem" - trackingIds: - type: "array" - items: - type: "string" - isParentInvoice: - type: "boolean" - parentInvoiceId: - type: "string" - format: "uuid" - parentAccountId: + id: type: "string" format: "uuid" - auditLogs: - type: "array" - items: - $ref: "#/definitions/AuditLog" - InvoiceItem: + Tag: type: "object" - required: - - "accountId" - - "invoiceItemId" properties: - invoiceItemId: - type: "string" - format: "uuid" - invoiceId: - type: "string" - format: "uuid" - linkedInvoiceItemId: - type: "string" - format: "uuid" - accountId: + tagId: type: "string" format: "uuid" - childAccountId: + objectType: type: "string" - format: "uuid" - bundleId: + enum: + - "ACCOUNT" + - "ACCOUNT_EMAIL" + - "BLOCKING_STATES" + - "BUNDLE" + - "CUSTOM_FIELD" + - "INVOICE" + - "PAYMENT" + - "TRANSACTION" + - "INVOICE_ITEM" + - "INVOICE_PAYMENT" + - "SUBSCRIPTION" + - "SUBSCRIPTION_EVENT" + - "SERVICE_BROADCAST" + - "PAYMENT_ATTEMPT" + - "PAYMENT_METHOD" + - "TAG" + - "TAG_DEFINITION" + - "TENANT" + - "TENANT_KVS" + objectId: type: "string" format: "uuid" - subscriptionId: + tagDefinitionId: type: "string" format: "uuid" - productName: - type: "string" - planName: - type: "string" - phaseName: - type: "string" - usageName: - type: "string" - prettyProductName: - type: "string" - prettyPlanName: - type: "string" - prettyPhaseName: - type: "string" - prettyUsageName: - type: "string" - itemType: - type: "string" - enum: - - "EXTERNAL_CHARGE" - - "FIXED" - - "RECURRING" - - "REPAIR_ADJ" - - "CBA_ADJ" - - "CREDIT_ADJ" - - "ITEM_ADJ" - - "USAGE" - - "TAX" - - "PARENT_SUMMARY" - description: - type: "string" - startDate: - type: "string" - format: "date" - endDate: - type: "string" - format: "date" - amount: - type: "number" - rate: - type: "number" - currency: - type: "string" - enum: - - "AED" - - "AFN" - - "ALL" - - "AMD" - - "ANG" - - "AOA" - - "ARS" - - "AUD" - - "AWG" - - "AZN" - - "BAM" - - "BBD" - - "BDT" - - "BGN" - - "BHD" - - "BIF" - - "BMD" - - "BND" - - "BOB" - - "BRL" - - "BSD" - - "BTN" - - "BWP" - - "BYR" - - "BZD" - - "CAD" - - "CDF" - - "CHF" - - "CLP" - - "CNY" - - "COP" - - "CRC" - - "CUC" - - "CUP" - - "CVE" - - "CZK" - - "DJF" - - "DKK" - - "DOP" - - "DZD" - - "EGP" - - "ERN" - - "ETB" - - "EUR" - - "FJD" - - "FKP" - - "GBP" - - "GEL" - - "GGP" - - "GHS" - - "GIP" - - "GMD" - - "GNF" - - "GTQ" - - "GYD" - - "HKD" - - "HNL" - - "HRK" - - "HTG" - - "HUF" - - "IDR" - - "ILS" - - "IMP" - - "INR" - - "IQD" - - "IRR" - - "ISK" - - "JEP" - - "JMD" - - "JOD" - - "JPY" - - "KES" - - "KGS" - - "KHR" - - "KMF" - - "KPW" - - "KRW" - - "KWD" - - "KYD" - - "KZT" - - "LAK" - - "LBP" - - "LKR" - - "LRD" - - "LSL" - - "LTL" - - "LVL" - - "LYD" - - "MAD" - - "MDL" - - "MGA" - - "MKD" - - "MMK" - - "MNT" - - "MOP" - - "MRO" - - "MUR" - - "MVR" - - "MWK" - - "MXN" - - "MYR" - - "MZN" - - "NAD" - - "NGN" - - "NIO" - - "NOK" - - "NPR" - - "NZD" - - "OMR" - - "PAB" - - "PEN" - - "PGK" - - "PHP" - - "PKR" - - "PLN" - - "PYG" - - "QAR" - - "RON" - - "RSD" - - "RUB" - - "RWF" - - "SAR" - - "SBD" - - "SCR" - - "SDG" - - "SEK" - - "SGD" - - "SHP" - - "SLL" - - "SOS" - - "SPL" - - "SRD" - - "STD" - - "SVC" - - "SYP" - - "SZL" - - "THB" - - "TJS" - - "TMT" - - "TND" - - "TOP" - - "TRY" - - "TTD" - - "TVD" - - "TWD" - - "TZS" - - "UAH" - - "UGX" - - "USD" - - "UYU" - - "UZS" - - "VEF" - - "VND" - - "VUV" - - "WST" - - "XAF" - - "XCD" - - "XDR" - - "XOF" - - "XPF" - - "YER" - - "ZAR" - - "ZMW" - - "ZWD" - - "BTC" - quantity: - type: "number" - itemDetails: - type: "string" - catalogEffectiveDate: + tagDefinitionName: type: "string" - format: "date-time" - childItems: - type: "array" - items: - $ref: "#/definitions/InvoiceItem" auditLogs: type: "array" items: $ref: "#/definitions/AuditLog" - PaymentMethod: + AccountEmail: type: "object" + required: + - "email" properties: - paymentMethodId: - type: "string" - format: "uuid" - externalKey: - type: "string" accountId: type: "string" format: "uuid" - isDefault: - type: "boolean" - pluginName: + email: type: "string" - pluginInfo: - $ref: "#/definitions/PaymentMethodPluginDetail" auditLogs: type: "array" items: $ref: "#/definitions/AuditLog" - PaymentMethodPluginDetail: - type: "object" - properties: - externalPaymentMethodId: - type: "string" - isDefaultPaymentMethod: - type: "boolean" - properties: - type: "array" - items: - $ref: "#/definitions/PluginProperty" - PluginProperty: - type: "object" - properties: - key: - type: "string" - value: - type: "string" - isUpdatable: - type: "boolean" - Payment: + Account: type: "object" properties: accountId: type: "string" format: "uuid" - paymentId: + name: type: "string" - format: "uuid" - paymentNumber: + firstNameLength: + type: "integer" + format: "int32" + externalKey: type: "string" - paymentExternalKey: + email: type: "string" - authAmount: - type: "number" - capturedAmount: - type: "number" - purchasedAmount: - type: "number" - refundedAmount: - type: "number" - creditedAmount: - type: "number" + billCycleDayLocal: + type: "integer" + format: "int32" currency: type: "string" enum: - - "AED" - - "AFN" - - "ALL" - - "AMD" - - "ANG" - - "AOA" - - "ARS" - - "AUD" - - "AWG" - - "AZN" - - "BAM" - - "BBD" - - "BDT" - - "BGN" - - "BHD" - - "BIF" - - "BMD" - - "BND" - - "BOB" - - "BRL" - - "BSD" - - "BTN" - - "BWP" - - "BYR" - - "BZD" - - "CAD" - - "CDF" - - "CHF" - - "CLP" - - "CNY" - - "COP" - - "CRC" - - "CUC" - - "CUP" - - "CVE" - - "CZK" - - "DJF" - - "DKK" - - "DOP" - - "DZD" - - "EGP" - - "ERN" - - "ETB" - - "EUR" - - "FJD" - - "FKP" - - "GBP" - - "GEL" - - "GGP" - - "GHS" - - "GIP" - - "GMD" - - "GNF" - - "GTQ" - - "GYD" - - "HKD" - - "HNL" - - "HRK" - - "HTG" - - "HUF" - - "IDR" - - "ILS" - - "IMP" - - "INR" - - "IQD" - - "IRR" - - "ISK" - - "JEP" - - "JMD" - - "JOD" - - "JPY" - - "KES" - - "KGS" - - "KHR" - - "KMF" - - "KPW" - - "KRW" - - "KWD" - - "KYD" - - "KZT" - - "LAK" - - "LBP" - - "LKR" - - "LRD" - - "LSL" - - "LTL" - - "LVL" - - "LYD" - - "MAD" - - "MDL" - - "MGA" - - "MKD" - - "MMK" - - "MNT" - - "MOP" - - "MRO" - - "MUR" - - "MVR" - - "MWK" - - "MXN" - - "MYR" - - "MZN" - - "NAD" - - "NGN" - - "NIO" - - "NOK" - - "NPR" - - "NZD" - - "OMR" - - "PAB" - - "PEN" - - "PGK" - - "PHP" - - "PKR" - - "PLN" - - "PYG" - - "QAR" - - "RON" - - "RSD" - - "RUB" - - "RWF" - - "SAR" - - "SBD" - - "SCR" - - "SDG" - - "SEK" - - "SGD" - - "SHP" - - "SLL" - - "SOS" - - "SPL" - - "SRD" - - "STD" - - "SVC" - - "SYP" - - "SZL" - - "THB" - - "TJS" - - "TMT" - - "TND" - - "TOP" - - "TRY" - - "TTD" - - "TVD" - - "TWD" - - "TZS" - - "UAH" - - "UGX" - - "USD" - - "UYU" - - "UZS" - - "VEF" - - "VND" - - "VUV" - - "WST" - - "XAF" - - "XCD" - - "XDR" - - "XOF" - - "XPF" - - "YER" - - "ZAR" - - "ZMW" - - "ZWD" - - "BTC" - paymentMethodId: - type: "string" - format: "uuid" - transactions: - type: "array" - items: - $ref: "#/definitions/PaymentTransaction" - paymentAttempts: - type: "array" - items: - $ref: "#/definitions/PaymentAttempt" - auditLogs: - type: "array" - items: - $ref: "#/definitions/AuditLog" - PaymentAttempt: - type: "object" - properties: - accountId: - type: "string" - format: "uuid" - paymentMethodId: - type: "string" - format: "uuid" - paymentExternalKey: - type: "string" - transactionId: - type: "string" - format: "uuid" - transactionExternalKey: - type: "string" - transactionType: - type: "string" - enum: - - "AUTHORIZE" - - "CAPTURE" - - "CHARGEBACK" - - "CREDIT" - - "PURCHASE" - - "REFUND" - - "VOID" - effectiveDate: - type: "string" - format: "date-time" - stateName: - type: "string" - amount: - type: "number" - description: "Transaction amount, required except for void operations" - currency: - type: "string" - description: "Amount currency (account currency unless specified)" - enum: - - "AED" - - "AFN" - - "ALL" - - "AMD" - - "ANG" - - "AOA" - - "ARS" - - "AUD" - - "AWG" - - "AZN" - - "BAM" - - "BBD" - - "BDT" - - "BGN" - - "BHD" - - "BIF" - - "BMD" - - "BND" - - "BOB" - - "BRL" - - "BSD" - - "BTN" - - "BWP" - - "BYR" - - "BZD" - - "CAD" - - "CDF" - - "CHF" - - "CLP" - - "CNY" - - "COP" - - "CRC" - - "CUC" - - "CUP" - - "CVE" - - "CZK" - - "DJF" - - "DKK" - - "DOP" - - "DZD" - - "EGP" - - "ERN" - - "ETB" - - "EUR" - - "FJD" - - "FKP" - - "GBP" - - "GEL" - - "GGP" - - "GHS" - - "GIP" - - "GMD" - - "GNF" - - "GTQ" - - "GYD" - - "HKD" - - "HNL" - - "HRK" - - "HTG" - - "HUF" - - "IDR" - - "ILS" - - "IMP" - - "INR" - - "IQD" - - "IRR" - - "ISK" - - "JEP" - - "JMD" - - "JOD" - - "JPY" - - "KES" - - "KGS" - - "KHR" - - "KMF" - - "KPW" - - "KRW" - - "KWD" - - "KYD" - - "KZT" - - "LAK" - - "LBP" - - "LKR" - - "LRD" - - "LSL" - - "LTL" - - "LVL" - - "LYD" - - "MAD" - - "MDL" - - "MGA" - - "MKD" - - "MMK" - - "MNT" - - "MOP" - - "MRO" - - "MUR" - - "MVR" - - "MWK" - - "MXN" - - "MYR" - - "MZN" - - "NAD" - - "NGN" - - "NIO" - - "NOK" - - "NPR" - - "NZD" - - "OMR" - - "PAB" - - "PEN" - - "PGK" - - "PHP" - - "PKR" - - "PLN" - - "PYG" - - "QAR" - - "RON" - - "RSD" - - "RUB" - - "RWF" - - "SAR" - - "SBD" - - "SCR" - - "SDG" - - "SEK" - - "SGD" - - "SHP" - - "SLL" - - "SOS" - - "SPL" - - "SRD" - - "STD" - - "SVC" - - "SYP" - - "SZL" - - "THB" - - "TJS" - - "TMT" - - "TND" - - "TOP" - - "TRY" - - "TTD" - - "TVD" - - "TWD" - - "TZS" - - "UAH" - - "UGX" - - "USD" - - "UYU" - - "UZS" - - "VEF" - - "VND" - - "VUV" - - "WST" - - "XAF" - - "XCD" - - "XDR" - - "XOF" - - "XPF" - - "YER" - - "ZAR" - - "ZMW" - - "ZWD" - - "BTC" - pluginName: + - "AED" + - "AFN" + - "ALL" + - "AMD" + - "ANG" + - "AOA" + - "ARS" + - "AUD" + - "AWG" + - "AZN" + - "BAM" + - "BBD" + - "BDT" + - "BGN" + - "BHD" + - "BIF" + - "BMD" + - "BND" + - "BOB" + - "BRL" + - "BSD" + - "BTN" + - "BWP" + - "BYR" + - "BZD" + - "CAD" + - "CDF" + - "CHF" + - "CLP" + - "CNY" + - "COP" + - "CRC" + - "CUC" + - "CUP" + - "CVE" + - "CZK" + - "DJF" + - "DKK" + - "DOP" + - "DZD" + - "EGP" + - "ERN" + - "ETB" + - "EUR" + - "FJD" + - "FKP" + - "GBP" + - "GEL" + - "GGP" + - "GHS" + - "GIP" + - "GMD" + - "GNF" + - "GTQ" + - "GYD" + - "HKD" + - "HNL" + - "HRK" + - "HTG" + - "HUF" + - "IDR" + - "ILS" + - "IMP" + - "INR" + - "IQD" + - "IRR" + - "ISK" + - "JEP" + - "JMD" + - "JOD" + - "JPY" + - "KES" + - "KGS" + - "KHR" + - "KMF" + - "KPW" + - "KRW" + - "KWD" + - "KYD" + - "KZT" + - "LAK" + - "LBP" + - "LKR" + - "LRD" + - "LSL" + - "LTL" + - "LVL" + - "LYD" + - "MAD" + - "MDL" + - "MGA" + - "MKD" + - "MMK" + - "MNT" + - "MOP" + - "MRO" + - "MUR" + - "MVR" + - "MWK" + - "MXN" + - "MYR" + - "MZN" + - "NAD" + - "NGN" + - "NIO" + - "NOK" + - "NPR" + - "NZD" + - "OMR" + - "PAB" + - "PEN" + - "PGK" + - "PHP" + - "PKR" + - "PLN" + - "PYG" + - "QAR" + - "RON" + - "RSD" + - "RUB" + - "RWF" + - "SAR" + - "SBD" + - "SCR" + - "SDG" + - "SEK" + - "SGD" + - "SHP" + - "SLL" + - "SOS" + - "SPL" + - "SRD" + - "STD" + - "SVC" + - "SYP" + - "SZL" + - "THB" + - "TJS" + - "TMT" + - "TND" + - "TOP" + - "TRY" + - "TTD" + - "TVD" + - "TWD" + - "TZS" + - "UAH" + - "UGX" + - "USD" + - "UYU" + - "UZS" + - "VEF" + - "VND" + - "VUV" + - "WST" + - "XAF" + - "XCD" + - "XDR" + - "XOF" + - "XPF" + - "YER" + - "ZAR" + - "ZMW" + - "ZWD" + - "BTC" + parentAccountId: type: "string" - pluginProperties: - type: "array" - items: - $ref: "#/definitions/PluginProperty" - auditLogs: - type: "array" - items: - $ref: "#/definitions/AuditLog" - PaymentTransaction: - type: "object" - properties: - transactionId: + format: "uuid" + isPaymentDelegatedToParent: + type: "boolean" + paymentMethodId: type: "string" format: "uuid" - transactionExternalKey: + referenceTime: type: "string" - paymentId: + format: "date-time" + timeZone: type: "string" - format: "uuid" - description: "Associated payment id, required when notifying state transitions" - paymentExternalKey: + address1: type: "string" - transactionType: + address2: type: "string" - enum: - - "AUTHORIZE" - - "CAPTURE" - - "CHARGEBACK" - - "CREDIT" - - "PURCHASE" - - "REFUND" - - "VOID" - amount: - type: "number" - description: "Transaction amount, required except for void operations" - currency: + postalCode: type: "string" - description: "Amount currency (account currency unless specified)" - enum: - - "AED" - - "AFN" - - "ALL" - - "AMD" - - "ANG" - - "AOA" - - "ARS" - - "AUD" - - "AWG" - - "AZN" - - "BAM" - - "BBD" - - "BDT" - - "BGN" - - "BHD" - - "BIF" - - "BMD" - - "BND" - - "BOB" - - "BRL" - - "BSD" - - "BTN" - - "BWP" - - "BYR" - - "BZD" - - "CAD" - - "CDF" - - "CHF" - - "CLP" - - "CNY" - - "COP" - - "CRC" - - "CUC" - - "CUP" - - "CVE" - - "CZK" - - "DJF" - - "DKK" - - "DOP" - - "DZD" - - "EGP" - - "ERN" - - "ETB" - - "EUR" - - "FJD" - - "FKP" - - "GBP" - - "GEL" - - "GGP" - - "GHS" - - "GIP" - - "GMD" - - "GNF" - - "GTQ" - - "GYD" - - "HKD" - - "HNL" - - "HRK" - - "HTG" - - "HUF" - - "IDR" - - "ILS" - - "IMP" - - "INR" - - "IQD" - - "IRR" - - "ISK" - - "JEP" - - "JMD" - - "JOD" - - "JPY" - - "KES" - - "KGS" - - "KHR" - - "KMF" - - "KPW" - - "KRW" - - "KWD" - - "KYD" - - "KZT" - - "LAK" - - "LBP" - - "LKR" - - "LRD" - - "LSL" - - "LTL" - - "LVL" - - "LYD" - - "MAD" - - "MDL" - - "MGA" - - "MKD" - - "MMK" - - "MNT" - - "MOP" - - "MRO" - - "MUR" - - "MVR" - - "MWK" - - "MXN" - - "MYR" - - "MZN" - - "NAD" - - "NGN" - - "NIO" - - "NOK" - - "NPR" - - "NZD" - - "OMR" - - "PAB" - - "PEN" - - "PGK" - - "PHP" - - "PKR" - - "PLN" - - "PYG" - - "QAR" - - "RON" - - "RSD" - - "RUB" - - "RWF" - - "SAR" - - "SBD" - - "SCR" - - "SDG" - - "SEK" - - "SGD" - - "SHP" - - "SLL" - - "SOS" - - "SPL" - - "SRD" - - "STD" - - "SVC" - - "SYP" - - "SZL" - - "THB" - - "TJS" - - "TMT" - - "TND" - - "TOP" - - "TRY" - - "TTD" - - "TVD" - - "TWD" - - "TZS" - - "UAH" - - "UGX" - - "USD" - - "UYU" - - "UZS" - - "VEF" - - "VND" - - "VUV" - - "WST" - - "XAF" - - "XCD" - - "XDR" - - "XOF" - - "XPF" - - "YER" - - "ZAR" - - "ZMW" - - "ZWD" - - "BTC" - effectiveDate: + company: type: "string" - format: "date-time" - processedAmount: - type: "number" - processedCurrency: + city: type: "string" - enum: - - "AED" - - "AFN" - - "ALL" - - "AMD" - - "ANG" - - "AOA" - - "ARS" - - "AUD" - - "AWG" - - "AZN" - - "BAM" - - "BBD" - - "BDT" - - "BGN" - - "BHD" - - "BIF" - - "BMD" - - "BND" - - "BOB" - - "BRL" - - "BSD" - - "BTN" - - "BWP" - - "BYR" - - "BZD" - - "CAD" - - "CDF" - - "CHF" - - "CLP" - - "CNY" - - "COP" - - "CRC" - - "CUC" - - "CUP" - - "CVE" - - "CZK" - - "DJF" - - "DKK" - - "DOP" - - "DZD" - - "EGP" - - "ERN" - - "ETB" - - "EUR" - - "FJD" - - "FKP" - - "GBP" - - "GEL" - - "GGP" - - "GHS" - - "GIP" - - "GMD" - - "GNF" - - "GTQ" - - "GYD" - - "HKD" - - "HNL" - - "HRK" - - "HTG" - - "HUF" - - "IDR" - - "ILS" - - "IMP" - - "INR" - - "IQD" - - "IRR" - - "ISK" - - "JEP" - - "JMD" - - "JOD" - - "JPY" - - "KES" - - "KGS" - - "KHR" - - "KMF" - - "KPW" - - "KRW" - - "KWD" - - "KYD" - - "KZT" - - "LAK" - - "LBP" - - "LKR" - - "LRD" - - "LSL" - - "LTL" - - "LVL" - - "LYD" - - "MAD" - - "MDL" - - "MGA" - - "MKD" - - "MMK" - - "MNT" - - "MOP" - - "MRO" - - "MUR" - - "MVR" - - "MWK" - - "MXN" - - "MYR" - - "MZN" - - "NAD" - - "NGN" - - "NIO" - - "NOK" - - "NPR" - - "NZD" - - "OMR" - - "PAB" - - "PEN" - - "PGK" - - "PHP" - - "PKR" - - "PLN" - - "PYG" - - "QAR" - - "RON" - - "RSD" - - "RUB" - - "RWF" - - "SAR" - - "SBD" - - "SCR" - - "SDG" - - "SEK" - - "SGD" - - "SHP" - - "SLL" - - "SOS" - - "SPL" - - "SRD" - - "STD" - - "SVC" - - "SYP" - - "SZL" - - "THB" - - "TJS" - - "TMT" - - "TND" - - "TOP" - - "TRY" - - "TTD" - - "TVD" - - "TWD" - - "TZS" - - "UAH" - - "UGX" - - "USD" - - "UYU" - - "UZS" - - "VEF" - - "VND" - - "VUV" - - "WST" - - "XAF" - - "XCD" - - "XDR" - - "XOF" - - "XPF" - - "YER" - - "ZAR" - - "ZMW" - - "ZWD" - - "BTC" - status: + state: type: "string" - description: "Transaction status, required for state change notifications" - enum: - - "SUCCESS" - - "UNKNOWN" - - "PENDING" - - "PAYMENT_FAILURE" - - "PLUGIN_FAILURE" - - "PAYMENT_SYSTEM_OFF" - gatewayErrorCode: + country: type: "string" - gatewayErrorMsg: + locale: type: "string" - firstPaymentReferenceId: + phone: type: "string" - secondPaymentReferenceId: + notes: type: "string" - properties: - type: "array" - items: - $ref: "#/definitions/PluginProperty" + isMigrated: + type: "boolean" + accountBalance: + type: "number" + accountCBA: + type: "number" auditLogs: type: "array" items: $ref: "#/definitions/AuditLog" - Tag: + BlockingState: type: "object" properties: - tagId: + blockedId: type: "string" format: "uuid" - objectType: + stateName: type: "string" - enum: - - "ACCOUNT" - - "ACCOUNT_EMAIL" - - "BLOCKING_STATES" - - "BUNDLE" - - "CUSTOM_FIELD" - - "INVOICE" - - "PAYMENT" - - "TRANSACTION" - - "INVOICE_ITEM" - - "INVOICE_PAYMENT" - - "SUBSCRIPTION" - - "SUBSCRIPTION_EVENT" - - "SERVICE_BROADCAST" - - "PAYMENT_ATTEMPT" - - "PAYMENT_METHOD" - - "TAG" - - "TAG_DEFINITION" - - "TENANT" - - "TENANT_KVS" - objectId: + service: type: "string" - format: "uuid" - tagDefinitionId: + isBlockChange: + type: "boolean" + isBlockEntitlement: + type: "boolean" + isBlockBilling: + type: "boolean" + effectiveDate: type: "string" - format: "uuid" - tagDefinitionName: + format: "date-time" + type: type: "string" + enum: + - "SUBSCRIPTION" + - "SUBSCRIPTION_BUNDLE" + - "ACCOUNT" auditLogs: type: "array" items: $ref: "#/definitions/AuditLog" - BlockPrice: + InvoicePayment: type: "object" properties: - unitName: + targetInvoiceId: type: "string" - size: - type: "number" - price: - type: "number" - max: - type: "number" - Bundle: - type: "object" - required: - - "accountId" - properties: + format: "uuid" accountId: type: "string" format: "uuid" - bundleId: + paymentId: type: "string" format: "uuid" - externalKey: + paymentNumber: type: "string" - subscriptions: + paymentExternalKey: + type: "string" + authAmount: + type: "number" + capturedAmount: + type: "number" + purchasedAmount: + type: "number" + refundedAmount: + type: "number" + creditedAmount: + type: "number" + currency: + type: "string" + enum: + - "AED" + - "AFN" + - "ALL" + - "AMD" + - "ANG" + - "AOA" + - "ARS" + - "AUD" + - "AWG" + - "AZN" + - "BAM" + - "BBD" + - "BDT" + - "BGN" + - "BHD" + - "BIF" + - "BMD" + - "BND" + - "BOB" + - "BRL" + - "BSD" + - "BTN" + - "BWP" + - "BYR" + - "BZD" + - "CAD" + - "CDF" + - "CHF" + - "CLP" + - "CNY" + - "COP" + - "CRC" + - "CUC" + - "CUP" + - "CVE" + - "CZK" + - "DJF" + - "DKK" + - "DOP" + - "DZD" + - "EGP" + - "ERN" + - "ETB" + - "EUR" + - "FJD" + - "FKP" + - "GBP" + - "GEL" + - "GGP" + - "GHS" + - "GIP" + - "GMD" + - "GNF" + - "GTQ" + - "GYD" + - "HKD" + - "HNL" + - "HRK" + - "HTG" + - "HUF" + - "IDR" + - "ILS" + - "IMP" + - "INR" + - "IQD" + - "IRR" + - "ISK" + - "JEP" + - "JMD" + - "JOD" + - "JPY" + - "KES" + - "KGS" + - "KHR" + - "KMF" + - "KPW" + - "KRW" + - "KWD" + - "KYD" + - "KZT" + - "LAK" + - "LBP" + - "LKR" + - "LRD" + - "LSL" + - "LTL" + - "LVL" + - "LYD" + - "MAD" + - "MDL" + - "MGA" + - "MKD" + - "MMK" + - "MNT" + - "MOP" + - "MRO" + - "MUR" + - "MVR" + - "MWK" + - "MXN" + - "MYR" + - "MZN" + - "NAD" + - "NGN" + - "NIO" + - "NOK" + - "NPR" + - "NZD" + - "OMR" + - "PAB" + - "PEN" + - "PGK" + - "PHP" + - "PKR" + - "PLN" + - "PYG" + - "QAR" + - "RON" + - "RSD" + - "RUB" + - "RWF" + - "SAR" + - "SBD" + - "SCR" + - "SDG" + - "SEK" + - "SGD" + - "SHP" + - "SLL" + - "SOS" + - "SPL" + - "SRD" + - "STD" + - "SVC" + - "SYP" + - "SZL" + - "THB" + - "TJS" + - "TMT" + - "TND" + - "TOP" + - "TRY" + - "TTD" + - "TVD" + - "TWD" + - "TZS" + - "UAH" + - "UGX" + - "USD" + - "UYU" + - "UZS" + - "VEF" + - "VND" + - "VUV" + - "WST" + - "XAF" + - "XCD" + - "XDR" + - "XOF" + - "XPF" + - "YER" + - "ZAR" + - "ZMW" + - "ZWD" + - "BTC" + paymentMethodId: + type: "string" + format: "uuid" + transactions: type: "array" items: - $ref: "#/definitions/Subscription" - timeline: - $ref: "#/definitions/BundleTimeline" + $ref: "#/definitions/PaymentTransaction" + paymentAttempts: + type: "array" + items: + $ref: "#/definitions/PaymentAttempt" auditLogs: type: "array" items: $ref: "#/definitions/AuditLog" - BundleTimeline: + PaymentAttempt: type: "object" properties: accountId: type: "string" format: "uuid" - bundleId: + paymentMethodId: type: "string" format: "uuid" - externalKey: + paymentExternalKey: type: "string" - events: - type: "array" - items: - $ref: "#/definitions/EventSubscription" - auditLogs: - type: "array" - items: - $ref: "#/definitions/AuditLog" - EventSubscription: - type: "object" - properties: - eventId: + transactionId: type: "string" format: "uuid" - billingPeriod: + transactionExternalKey: + type: "string" + transactionType: type: "string" enum: - - "DAILY" - - "WEEKLY" - - "BIWEEKLY" - - "THIRTY_DAYS" - - "THIRTY_ONE_DAYS" - - "SIXTY_DAYS" - - "NINETY_DAYS" - - "MONTHLY" - - "BIMESTRIAL" - - "QUARTERLY" - - "TRIANNUAL" - - "BIANNUAL" - - "ANNUAL" - - "SESQUIENNIAL" - - "BIENNIAL" - - "TRIENNIAL" - - "NO_BILLING_PERIOD" + - "AUTHORIZE" + - "CAPTURE" + - "CHARGEBACK" + - "CREDIT" + - "PURCHASE" + - "REFUND" + - "VOID" effectiveDate: type: "string" format: "date-time" - catalogEffectiveDate: + stateName: type: "string" - format: "date-time" - plan: - type: "string" - product: - type: "string" - priceList: - type: "string" - eventType: + amount: + type: "number" + description: "Transaction amount, required except for void operations" + currency: type: "string" + description: "Amount currency (account currency unless specified)" enum: - - "START_ENTITLEMENT" - - "START_BILLING" - - "PAUSE_ENTITLEMENT" - - "PAUSE_BILLING" - - "RESUME_ENTITLEMENT" - - "RESUME_BILLING" - - "PHASE" - - "CHANGE" - - "STOP_ENTITLEMENT" - - "STOP_BILLING" - - "SERVICE_STATE_CHANGE" - isBlockedBilling: - type: "boolean" - isBlockedEntitlement: - type: "boolean" - serviceName: - type: "string" - serviceStateName: - type: "string" - phase: + - "AED" + - "AFN" + - "ALL" + - "AMD" + - "ANG" + - "AOA" + - "ARS" + - "AUD" + - "AWG" + - "AZN" + - "BAM" + - "BBD" + - "BDT" + - "BGN" + - "BHD" + - "BIF" + - "BMD" + - "BND" + - "BOB" + - "BRL" + - "BSD" + - "BTN" + - "BWP" + - "BYR" + - "BZD" + - "CAD" + - "CDF" + - "CHF" + - "CLP" + - "CNY" + - "COP" + - "CRC" + - "CUC" + - "CUP" + - "CVE" + - "CZK" + - "DJF" + - "DKK" + - "DOP" + - "DZD" + - "EGP" + - "ERN" + - "ETB" + - "EUR" + - "FJD" + - "FKP" + - "GBP" + - "GEL" + - "GGP" + - "GHS" + - "GIP" + - "GMD" + - "GNF" + - "GTQ" + - "GYD" + - "HKD" + - "HNL" + - "HRK" + - "HTG" + - "HUF" + - "IDR" + - "ILS" + - "IMP" + - "INR" + - "IQD" + - "IRR" + - "ISK" + - "JEP" + - "JMD" + - "JOD" + - "JPY" + - "KES" + - "KGS" + - "KHR" + - "KMF" + - "KPW" + - "KRW" + - "KWD" + - "KYD" + - "KZT" + - "LAK" + - "LBP" + - "LKR" + - "LRD" + - "LSL" + - "LTL" + - "LVL" + - "LYD" + - "MAD" + - "MDL" + - "MGA" + - "MKD" + - "MMK" + - "MNT" + - "MOP" + - "MRO" + - "MUR" + - "MVR" + - "MWK" + - "MXN" + - "MYR" + - "MZN" + - "NAD" + - "NGN" + - "NIO" + - "NOK" + - "NPR" + - "NZD" + - "OMR" + - "PAB" + - "PEN" + - "PGK" + - "PHP" + - "PKR" + - "PLN" + - "PYG" + - "QAR" + - "RON" + - "RSD" + - "RUB" + - "RWF" + - "SAR" + - "SBD" + - "SCR" + - "SDG" + - "SEK" + - "SGD" + - "SHP" + - "SLL" + - "SOS" + - "SPL" + - "SRD" + - "STD" + - "SVC" + - "SYP" + - "SZL" + - "THB" + - "TJS" + - "TMT" + - "TND" + - "TOP" + - "TRY" + - "TTD" + - "TVD" + - "TWD" + - "TZS" + - "UAH" + - "UGX" + - "USD" + - "UYU" + - "UZS" + - "VEF" + - "VND" + - "VUV" + - "WST" + - "XAF" + - "XCD" + - "XDR" + - "XOF" + - "XPF" + - "YER" + - "ZAR" + - "ZMW" + - "ZWD" + - "BTC" + pluginName: type: "string" - auditLogs: + pluginProperties: type: "array" items: - $ref: "#/definitions/AuditLog" - PhasePrice: - type: "object" - properties: - planName: - type: "string" - phaseName: - type: "string" - phaseType: - type: "string" - fixedPrice: - type: "number" - recurringPrice: - type: "number" - usagePrices: + $ref: "#/definitions/PluginProperty" + auditLogs: type: "array" items: - $ref: "#/definitions/UsagePrice" - Subscription: + $ref: "#/definitions/AuditLog" + PaymentTransaction: type: "object" - required: - - "billingPeriod" - - "planName" - - "priceList" - - "productName" properties: - accountId: - type: "string" - format: "uuid" - bundleId: + transactionId: type: "string" format: "uuid" - bundleExternalKey: + transactionExternalKey: type: "string" - subscriptionId: + paymentId: type: "string" format: "uuid" - externalKey: - type: "string" - startDate: - type: "string" - format: "date-time" - productName: - type: "string" - productCategory: - type: "string" - enum: - - "BASE" - - "ADD_ON" - - "STANDALONE" - billingPeriod: - type: "string" - enum: - - "DAILY" - - "WEEKLY" - - "BIWEEKLY" - - "THIRTY_DAYS" - - "THIRTY_ONE_DAYS" - - "SIXTY_DAYS" - - "NINETY_DAYS" - - "MONTHLY" - - "BIMESTRIAL" - - "QUARTERLY" - - "TRIANNUAL" - - "BIANNUAL" - - "ANNUAL" - - "SESQUIENNIAL" - - "BIENNIAL" - - "TRIENNIAL" - - "NO_BILLING_PERIOD" - phaseType: - type: "string" - enum: - - "TRIAL" - - "DISCOUNT" - - "FIXEDTERM" - - "EVERGREEN" - priceList: - type: "string" - planName: + description: "Associated payment id, required when notifying state transitions" + paymentExternalKey: type: "string" - state: + transactionType: type: "string" enum: - - "PENDING" - - "ACTIVE" - - "BLOCKED" - - "CANCELLED" - - "EXPIRED" - sourceType: + - "AUTHORIZE" + - "CAPTURE" + - "CHARGEBACK" + - "CREDIT" + - "PURCHASE" + - "REFUND" + - "VOID" + amount: + type: "number" + description: "Transaction amount, required except for void operations" + currency: type: "string" + description: "Amount currency (account currency unless specified)" enum: - - "NATIVE" - - "MIGRATED" - - "TRANSFERRED" - cancelledDate: - type: "string" - format: "date-time" - chargedThroughDate: - type: "string" - format: "date" - billingStartDate: - type: "string" + - "AED" + - "AFN" + - "ALL" + - "AMD" + - "ANG" + - "AOA" + - "ARS" + - "AUD" + - "AWG" + - "AZN" + - "BAM" + - "BBD" + - "BDT" + - "BGN" + - "BHD" + - "BIF" + - "BMD" + - "BND" + - "BOB" + - "BRL" + - "BSD" + - "BTN" + - "BWP" + - "BYR" + - "BZD" + - "CAD" + - "CDF" + - "CHF" + - "CLP" + - "CNY" + - "COP" + - "CRC" + - "CUC" + - "CUP" + - "CVE" + - "CZK" + - "DJF" + - "DKK" + - "DOP" + - "DZD" + - "EGP" + - "ERN" + - "ETB" + - "EUR" + - "FJD" + - "FKP" + - "GBP" + - "GEL" + - "GGP" + - "GHS" + - "GIP" + - "GMD" + - "GNF" + - "GTQ" + - "GYD" + - "HKD" + - "HNL" + - "HRK" + - "HTG" + - "HUF" + - "IDR" + - "ILS" + - "IMP" + - "INR" + - "IQD" + - "IRR" + - "ISK" + - "JEP" + - "JMD" + - "JOD" + - "JPY" + - "KES" + - "KGS" + - "KHR" + - "KMF" + - "KPW" + - "KRW" + - "KWD" + - "KYD" + - "KZT" + - "LAK" + - "LBP" + - "LKR" + - "LRD" + - "LSL" + - "LTL" + - "LVL" + - "LYD" + - "MAD" + - "MDL" + - "MGA" + - "MKD" + - "MMK" + - "MNT" + - "MOP" + - "MRO" + - "MUR" + - "MVR" + - "MWK" + - "MXN" + - "MYR" + - "MZN" + - "NAD" + - "NGN" + - "NIO" + - "NOK" + - "NPR" + - "NZD" + - "OMR" + - "PAB" + - "PEN" + - "PGK" + - "PHP" + - "PKR" + - "PLN" + - "PYG" + - "QAR" + - "RON" + - "RSD" + - "RUB" + - "RWF" + - "SAR" + - "SBD" + - "SCR" + - "SDG" + - "SEK" + - "SGD" + - "SHP" + - "SLL" + - "SOS" + - "SPL" + - "SRD" + - "STD" + - "SVC" + - "SYP" + - "SZL" + - "THB" + - "TJS" + - "TMT" + - "TND" + - "TOP" + - "TRY" + - "TTD" + - "TVD" + - "TWD" + - "TZS" + - "UAH" + - "UGX" + - "USD" + - "UYU" + - "UZS" + - "VEF" + - "VND" + - "VUV" + - "WST" + - "XAF" + - "XCD" + - "XDR" + - "XOF" + - "XPF" + - "YER" + - "ZAR" + - "ZMW" + - "ZWD" + - "BTC" + effectiveDate: + type: "string" + format: "date-time" + processedAmount: + type: "number" + processedCurrency: + type: "string" + enum: + - "AED" + - "AFN" + - "ALL" + - "AMD" + - "ANG" + - "AOA" + - "ARS" + - "AUD" + - "AWG" + - "AZN" + - "BAM" + - "BBD" + - "BDT" + - "BGN" + - "BHD" + - "BIF" + - "BMD" + - "BND" + - "BOB" + - "BRL" + - "BSD" + - "BTN" + - "BWP" + - "BYR" + - "BZD" + - "CAD" + - "CDF" + - "CHF" + - "CLP" + - "CNY" + - "COP" + - "CRC" + - "CUC" + - "CUP" + - "CVE" + - "CZK" + - "DJF" + - "DKK" + - "DOP" + - "DZD" + - "EGP" + - "ERN" + - "ETB" + - "EUR" + - "FJD" + - "FKP" + - "GBP" + - "GEL" + - "GGP" + - "GHS" + - "GIP" + - "GMD" + - "GNF" + - "GTQ" + - "GYD" + - "HKD" + - "HNL" + - "HRK" + - "HTG" + - "HUF" + - "IDR" + - "ILS" + - "IMP" + - "INR" + - "IQD" + - "IRR" + - "ISK" + - "JEP" + - "JMD" + - "JOD" + - "JPY" + - "KES" + - "KGS" + - "KHR" + - "KMF" + - "KPW" + - "KRW" + - "KWD" + - "KYD" + - "KZT" + - "LAK" + - "LBP" + - "LKR" + - "LRD" + - "LSL" + - "LTL" + - "LVL" + - "LYD" + - "MAD" + - "MDL" + - "MGA" + - "MKD" + - "MMK" + - "MNT" + - "MOP" + - "MRO" + - "MUR" + - "MVR" + - "MWK" + - "MXN" + - "MYR" + - "MZN" + - "NAD" + - "NGN" + - "NIO" + - "NOK" + - "NPR" + - "NZD" + - "OMR" + - "PAB" + - "PEN" + - "PGK" + - "PHP" + - "PKR" + - "PLN" + - "PYG" + - "QAR" + - "RON" + - "RSD" + - "RUB" + - "RWF" + - "SAR" + - "SBD" + - "SCR" + - "SDG" + - "SEK" + - "SGD" + - "SHP" + - "SLL" + - "SOS" + - "SPL" + - "SRD" + - "STD" + - "SVC" + - "SYP" + - "SZL" + - "THB" + - "TJS" + - "TMT" + - "TND" + - "TOP" + - "TRY" + - "TTD" + - "TVD" + - "TWD" + - "TZS" + - "UAH" + - "UGX" + - "USD" + - "UYU" + - "UZS" + - "VEF" + - "VND" + - "VUV" + - "WST" + - "XAF" + - "XCD" + - "XDR" + - "XOF" + - "XPF" + - "YER" + - "ZAR" + - "ZMW" + - "ZWD" + - "BTC" + status: + type: "string" + description: "Transaction status, required for state change notifications" + enum: + - "SUCCESS" + - "UNKNOWN" + - "PENDING" + - "PAYMENT_FAILURE" + - "PLUGIN_FAILURE" + - "PAYMENT_SYSTEM_OFF" + gatewayErrorCode: + type: "string" + gatewayErrorMsg: + type: "string" + firstPaymentReferenceId: + type: "string" + secondPaymentReferenceId: + type: "string" + properties: + type: "array" + items: + $ref: "#/definitions/PluginProperty" + auditLogs: + type: "array" + items: + $ref: "#/definitions/AuditLog" + PluginProperty: + type: "object" + properties: + key: + type: "string" + value: + type: "string" + isUpdatable: + type: "boolean" + CustomField: + type: "object" + required: + - "name" + - "value" + properties: + customFieldId: + type: "string" + format: "uuid" + objectId: + type: "string" + format: "uuid" + objectType: + type: "string" + enum: + - "ACCOUNT" + - "ACCOUNT_EMAIL" + - "BLOCKING_STATES" + - "BUNDLE" + - "CUSTOM_FIELD" + - "INVOICE" + - "PAYMENT" + - "TRANSACTION" + - "INVOICE_ITEM" + - "INVOICE_PAYMENT" + - "SUBSCRIPTION" + - "SUBSCRIPTION_EVENT" + - "SERVICE_BROADCAST" + - "PAYMENT_ATTEMPT" + - "PAYMENT_METHOD" + - "TAG" + - "TAG_DEFINITION" + - "TENANT" + - "TENANT_KVS" + name: + type: "string" + value: + type: "string" + auditLogs: + type: "array" + items: + $ref: "#/definitions/AuditLog" + PaymentMethod: + type: "object" + properties: + paymentMethodId: + type: "string" + format: "uuid" + externalKey: + type: "string" + accountId: + type: "string" + format: "uuid" + isDefault: + type: "boolean" + pluginName: + type: "string" + pluginInfo: + $ref: "#/definitions/PaymentMethodPluginDetail" + auditLogs: + type: "array" + items: + $ref: "#/definitions/AuditLog" + PaymentMethodPluginDetail: + type: "object" + properties: + externalPaymentMethodId: + type: "string" + isDefaultPaymentMethod: + type: "boolean" + properties: + type: "array" + items: + $ref: "#/definitions/PluginProperty" + BlockPrice: + type: "object" + properties: + unitName: + type: "string" + size: + type: "number" + price: + type: "number" + max: + type: "number" + Bundle: + type: "object" + required: + - "accountId" + properties: + accountId: + type: "string" + format: "uuid" + bundleId: + type: "string" + format: "uuid" + externalKey: + type: "string" + subscriptions: + type: "array" + items: + $ref: "#/definitions/Subscription" + timeline: + $ref: "#/definitions/BundleTimeline" + auditLogs: + type: "array" + items: + $ref: "#/definitions/AuditLog" + BundleTimeline: + type: "object" + properties: + accountId: + type: "string" + format: "uuid" + bundleId: + type: "string" + format: "uuid" + externalKey: + type: "string" + events: + type: "array" + items: + $ref: "#/definitions/EventSubscription" + auditLogs: + type: "array" + items: + $ref: "#/definitions/AuditLog" + EventSubscription: + type: "object" + properties: + eventId: + type: "string" + format: "uuid" + billingPeriod: + type: "string" + enum: + - "DAILY" + - "WEEKLY" + - "BIWEEKLY" + - "THIRTY_DAYS" + - "THIRTY_ONE_DAYS" + - "SIXTY_DAYS" + - "NINETY_DAYS" + - "MONTHLY" + - "BIMESTRIAL" + - "QUARTERLY" + - "TRIANNUAL" + - "BIANNUAL" + - "ANNUAL" + - "SESQUIENNIAL" + - "BIENNIAL" + - "TRIENNIAL" + - "NO_BILLING_PERIOD" + effectiveDate: + type: "string" + format: "date-time" + catalogEffectiveDate: + type: "string" + format: "date-time" + plan: + type: "string" + product: + type: "string" + priceList: + type: "string" + eventType: + type: "string" + enum: + - "START_ENTITLEMENT" + - "START_BILLING" + - "PAUSE_ENTITLEMENT" + - "PAUSE_BILLING" + - "RESUME_ENTITLEMENT" + - "RESUME_BILLING" + - "PHASE" + - "CHANGE" + - "STOP_ENTITLEMENT" + - "STOP_BILLING" + - "SERVICE_STATE_CHANGE" + isBlockedBilling: + type: "boolean" + isBlockedEntitlement: + type: "boolean" + serviceName: + type: "string" + serviceStateName: + type: "string" + phase: + type: "string" + auditLogs: + type: "array" + items: + $ref: "#/definitions/AuditLog" + PhasePrice: + type: "object" + properties: + planName: + type: "string" + phaseName: + type: "string" + phaseType: + type: "string" + fixedPrice: + type: "number" + recurringPrice: + type: "number" + usagePrices: + type: "array" + items: + $ref: "#/definitions/UsagePrice" + Subscription: + type: "object" + required: + - "billingPeriod" + - "planName" + - "priceList" + - "productName" + properties: + accountId: + type: "string" + format: "uuid" + bundleId: + type: "string" + format: "uuid" + bundleExternalKey: + type: "string" + subscriptionId: + type: "string" + format: "uuid" + externalKey: + type: "string" + startDate: + type: "string" + format: "date-time" + productName: + type: "string" + productCategory: + type: "string" + enum: + - "BASE" + - "ADD_ON" + - "STANDALONE" + billingPeriod: + type: "string" + enum: + - "DAILY" + - "WEEKLY" + - "BIWEEKLY" + - "THIRTY_DAYS" + - "THIRTY_ONE_DAYS" + - "SIXTY_DAYS" + - "NINETY_DAYS" + - "MONTHLY" + - "BIMESTRIAL" + - "QUARTERLY" + - "TRIANNUAL" + - "BIANNUAL" + - "ANNUAL" + - "SESQUIENNIAL" + - "BIENNIAL" + - "TRIENNIAL" + - "NO_BILLING_PERIOD" + phaseType: + type: "string" + enum: + - "TRIAL" + - "DISCOUNT" + - "FIXEDTERM" + - "EVERGREEN" + priceList: + type: "string" + planName: + type: "string" + state: + type: "string" + enum: + - "PENDING" + - "ACTIVE" + - "BLOCKED" + - "CANCELLED" + - "EXPIRED" + sourceType: + type: "string" + enum: + - "NATIVE" + - "MIGRATED" + - "TRANSFERRED" + cancelledDate: + type: "string" + format: "date-time" + chargedThroughDate: + type: "string" + format: "date" + billingStartDate: + type: "string" format: "date-time" billingEndDate: type: "string" @@ -13553,50 +13394,543 @@ definitions: events: type: "array" items: - $ref: "#/definitions/EventSubscription" - priceOverrides: + $ref: "#/definitions/EventSubscription" + priceOverrides: + type: "array" + items: + $ref: "#/definitions/PhasePrice" + prices: + type: "array" + items: + $ref: "#/definitions/PhasePrice" + auditLogs: + type: "array" + items: + $ref: "#/definitions/AuditLog" + TierPrice: + type: "object" + properties: + blockPrices: + type: "array" + items: + $ref: "#/definitions/BlockPrice" + UsagePrice: + type: "object" + properties: + usageName: + type: "string" + usageType: + type: "string" + enum: + - "CAPACITY" + - "CONSUMABLE" + billingMode: + type: "string" + enum: + - "IN_ADVANCE" + - "IN_ARREAR" + tierBlockPolicy: + type: "string" + enum: + - "ALL_TIERS" + - "TOP_TIER" + tierPrices: + type: "array" + items: + $ref: "#/definitions/TierPrice" + AccountTimeline: + type: "object" + properties: + account: + $ref: "#/definitions/Account" + bundles: + type: "array" + items: + $ref: "#/definitions/Bundle" + invoices: + type: "array" + items: + $ref: "#/definitions/Invoice" + payments: + type: "array" + items: + $ref: "#/definitions/InvoicePayment" + Invoice: + type: "object" + properties: + amount: + type: "number" + currency: + type: "string" + enum: + - "AED" + - "AFN" + - "ALL" + - "AMD" + - "ANG" + - "AOA" + - "ARS" + - "AUD" + - "AWG" + - "AZN" + - "BAM" + - "BBD" + - "BDT" + - "BGN" + - "BHD" + - "BIF" + - "BMD" + - "BND" + - "BOB" + - "BRL" + - "BSD" + - "BTN" + - "BWP" + - "BYR" + - "BZD" + - "CAD" + - "CDF" + - "CHF" + - "CLP" + - "CNY" + - "COP" + - "CRC" + - "CUC" + - "CUP" + - "CVE" + - "CZK" + - "DJF" + - "DKK" + - "DOP" + - "DZD" + - "EGP" + - "ERN" + - "ETB" + - "EUR" + - "FJD" + - "FKP" + - "GBP" + - "GEL" + - "GGP" + - "GHS" + - "GIP" + - "GMD" + - "GNF" + - "GTQ" + - "GYD" + - "HKD" + - "HNL" + - "HRK" + - "HTG" + - "HUF" + - "IDR" + - "ILS" + - "IMP" + - "INR" + - "IQD" + - "IRR" + - "ISK" + - "JEP" + - "JMD" + - "JOD" + - "JPY" + - "KES" + - "KGS" + - "KHR" + - "KMF" + - "KPW" + - "KRW" + - "KWD" + - "KYD" + - "KZT" + - "LAK" + - "LBP" + - "LKR" + - "LRD" + - "LSL" + - "LTL" + - "LVL" + - "LYD" + - "MAD" + - "MDL" + - "MGA" + - "MKD" + - "MMK" + - "MNT" + - "MOP" + - "MRO" + - "MUR" + - "MVR" + - "MWK" + - "MXN" + - "MYR" + - "MZN" + - "NAD" + - "NGN" + - "NIO" + - "NOK" + - "NPR" + - "NZD" + - "OMR" + - "PAB" + - "PEN" + - "PGK" + - "PHP" + - "PKR" + - "PLN" + - "PYG" + - "QAR" + - "RON" + - "RSD" + - "RUB" + - "RWF" + - "SAR" + - "SBD" + - "SCR" + - "SDG" + - "SEK" + - "SGD" + - "SHP" + - "SLL" + - "SOS" + - "SPL" + - "SRD" + - "STD" + - "SVC" + - "SYP" + - "SZL" + - "THB" + - "TJS" + - "TMT" + - "TND" + - "TOP" + - "TRY" + - "TTD" + - "TVD" + - "TWD" + - "TZS" + - "UAH" + - "UGX" + - "USD" + - "UYU" + - "UZS" + - "VEF" + - "VND" + - "VUV" + - "WST" + - "XAF" + - "XCD" + - "XDR" + - "XOF" + - "XPF" + - "YER" + - "ZAR" + - "ZMW" + - "ZWD" + - "BTC" + status: + type: "string" + enum: + - "DRAFT" + - "COMMITTED" + - "VOID" + creditAdj: + type: "number" + refundAdj: + type: "number" + invoiceId: + type: "string" + format: "uuid" + invoiceDate: + type: "string" + format: "date" + targetDate: + type: "string" + format: "date" + invoiceNumber: + type: "string" + balance: + type: "number" + accountId: + type: "string" + format: "uuid" + bundleKeys: + type: "string" + credits: + type: "array" + items: + $ref: "#/definitions/InvoiceItem" + items: type: "array" items: - $ref: "#/definitions/PhasePrice" - prices: + $ref: "#/definitions/InvoiceItem" + trackingIds: type: "array" items: - $ref: "#/definitions/PhasePrice" + type: "string" + isParentInvoice: + type: "boolean" + parentInvoiceId: + type: "string" + format: "uuid" + parentAccountId: + type: "string" + format: "uuid" auditLogs: type: "array" items: $ref: "#/definitions/AuditLog" - TierPrice: - type: "object" - properties: - blockPrices: - type: "array" - items: - $ref: "#/definitions/BlockPrice" - UsagePrice: + InvoiceItem: type: "object" + required: + - "accountId" + - "invoiceItemId" properties: + invoiceItemId: + type: "string" + format: "uuid" + invoiceId: + type: "string" + format: "uuid" + linkedInvoiceItemId: + type: "string" + format: "uuid" + accountId: + type: "string" + format: "uuid" + childAccountId: + type: "string" + format: "uuid" + bundleId: + type: "string" + format: "uuid" + subscriptionId: + type: "string" + format: "uuid" + productName: + type: "string" + planName: + type: "string" + phaseName: + type: "string" usageName: type: "string" - usageType: + prettyProductName: + type: "string" + prettyPlanName: + type: "string" + prettyPhaseName: + type: "string" + prettyUsageName: + type: "string" + itemType: type: "string" enum: - - "CAPACITY" - - "CONSUMABLE" - billingMode: + - "EXTERNAL_CHARGE" + - "FIXED" + - "RECURRING" + - "REPAIR_ADJ" + - "CBA_ADJ" + - "CREDIT_ADJ" + - "ITEM_ADJ" + - "USAGE" + - "TAX" + - "PARENT_SUMMARY" + description: + type: "string" + startDate: + type: "string" + format: "date" + endDate: + type: "string" + format: "date" + amount: + type: "number" + rate: + type: "number" + currency: + type: "string" + enum: + - "AED" + - "AFN" + - "ALL" + - "AMD" + - "ANG" + - "AOA" + - "ARS" + - "AUD" + - "AWG" + - "AZN" + - "BAM" + - "BBD" + - "BDT" + - "BGN" + - "BHD" + - "BIF" + - "BMD" + - "BND" + - "BOB" + - "BRL" + - "BSD" + - "BTN" + - "BWP" + - "BYR" + - "BZD" + - "CAD" + - "CDF" + - "CHF" + - "CLP" + - "CNY" + - "COP" + - "CRC" + - "CUC" + - "CUP" + - "CVE" + - "CZK" + - "DJF" + - "DKK" + - "DOP" + - "DZD" + - "EGP" + - "ERN" + - "ETB" + - "EUR" + - "FJD" + - "FKP" + - "GBP" + - "GEL" + - "GGP" + - "GHS" + - "GIP" + - "GMD" + - "GNF" + - "GTQ" + - "GYD" + - "HKD" + - "HNL" + - "HRK" + - "HTG" + - "HUF" + - "IDR" + - "ILS" + - "IMP" + - "INR" + - "IQD" + - "IRR" + - "ISK" + - "JEP" + - "JMD" + - "JOD" + - "JPY" + - "KES" + - "KGS" + - "KHR" + - "KMF" + - "KPW" + - "KRW" + - "KWD" + - "KYD" + - "KZT" + - "LAK" + - "LBP" + - "LKR" + - "LRD" + - "LSL" + - "LTL" + - "LVL" + - "LYD" + - "MAD" + - "MDL" + - "MGA" + - "MKD" + - "MMK" + - "MNT" + - "MOP" + - "MRO" + - "MUR" + - "MVR" + - "MWK" + - "MXN" + - "MYR" + - "MZN" + - "NAD" + - "NGN" + - "NIO" + - "NOK" + - "NPR" + - "NZD" + - "OMR" + - "PAB" + - "PEN" + - "PGK" + - "PHP" + - "PKR" + - "PLN" + - "PYG" + - "QAR" + - "RON" + - "RSD" + - "RUB" + - "RWF" + - "SAR" + - "SBD" + - "SCR" + - "SDG" + - "SEK" + - "SGD" + - "SHP" + - "SLL" + - "SOS" + - "SPL" + - "SRD" + - "STD" + - "SVC" + - "SYP" + - "SZL" + - "THB" + - "TJS" + - "TMT" + - "TND" + - "TOP" + - "TRY" + - "TTD" + - "TVD" + - "TWD" + - "TZS" + - "UAH" + - "UGX" + - "USD" + - "UYU" + - "UZS" + - "VEF" + - "VND" + - "VUV" + - "WST" + - "XAF" + - "XCD" + - "XDR" + - "XOF" + - "XPF" + - "YER" + - "ZAR" + - "ZMW" + - "ZWD" + - "BTC" + quantity: + type: "number" + itemDetails: type: "string" - enum: - - "IN_ADVANCE" - - "IN_ARREAR" - tierBlockPolicy: + catalogEffectiveDate: type: "string" - enum: - - "ALL_TIERS" - - "TOP_TIER" - tierPrices: + format: "date-time" + childItems: type: "array" items: - $ref: "#/definitions/TierPrice" + $ref: "#/definitions/InvoiceItem" + auditLogs: + type: "array" + items: + $ref: "#/definitions/AuditLog" OverdueState: type: "object" properties: @@ -13613,566 +13947,846 @@ definitions: reevaluationIntervalDays: type: "integer" format: "int32" - BlockingState: - type: "object" - properties: - blockedId: - type: "string" - format: "uuid" - stateName: - type: "string" - service: - type: "string" - isBlockChange: - type: "boolean" - isBlockEntitlement: - type: "boolean" - isBlockBilling: - type: "boolean" - effectiveDate: - type: "string" - format: "date-time" - type: - type: "string" - enum: - - "SUBSCRIPTION" - - "SUBSCRIPTION_BUNDLE" - - "ACCOUNT" - auditLogs: - type: "array" - items: - $ref: "#/definitions/AuditLog" - CustomField: - type: "object" - required: - - "name" - - "value" - properties: - customFieldId: - type: "string" - format: "uuid" - objectId: - type: "string" - format: "uuid" - objectType: - type: "string" - enum: - - "ACCOUNT" - - "ACCOUNT_EMAIL" - - "BLOCKING_STATES" - - "BUNDLE" - - "CUSTOM_FIELD" - - "INVOICE" - - "PAYMENT" - - "TRANSACTION" - - "INVOICE_ITEM" - - "INVOICE_PAYMENT" - - "SUBSCRIPTION" - - "SUBSCRIPTION_EVENT" - - "SERVICE_BROADCAST" - - "PAYMENT_ATTEMPT" - - "PAYMENT_METHOD" - - "TAG" - - "TAG_DEFINITION" - - "TENANT" - - "TENANT_KVS" - name: - type: "string" - value: - type: "string" - auditLogs: - type: "array" - items: - $ref: "#/definitions/AuditLog" - Account: + Payment: type: "object" properties: accountId: type: "string" format: "uuid" - name: + paymentId: type: "string" - firstNameLength: - type: "integer" - format: "int32" - externalKey: + format: "uuid" + paymentNumber: type: "string" - email: + paymentExternalKey: type: "string" - billCycleDayLocal: - type: "integer" - format: "int32" + authAmount: + type: "number" + capturedAmount: + type: "number" + purchasedAmount: + type: "number" + refundedAmount: + type: "number" + creditedAmount: + type: "number" currency: type: "string" enum: - - "AED" - - "AFN" - - "ALL" - - "AMD" - - "ANG" - - "AOA" - - "ARS" - - "AUD" - - "AWG" - - "AZN" - - "BAM" - - "BBD" - - "BDT" - - "BGN" - - "BHD" - - "BIF" - - "BMD" - - "BND" - - "BOB" - - "BRL" - - "BSD" - - "BTN" - - "BWP" - - "BYR" - - "BZD" - - "CAD" - - "CDF" - - "CHF" - - "CLP" - - "CNY" - - "COP" - - "CRC" - - "CUC" - - "CUP" - - "CVE" - - "CZK" - - "DJF" - - "DKK" - - "DOP" - - "DZD" - - "EGP" - - "ERN" - - "ETB" - - "EUR" - - "FJD" - - "FKP" - - "GBP" - - "GEL" - - "GGP" - - "GHS" - - "GIP" - - "GMD" - - "GNF" - - "GTQ" - - "GYD" - - "HKD" - - "HNL" - - "HRK" - - "HTG" - - "HUF" - - "IDR" - - "ILS" - - "IMP" - - "INR" - - "IQD" - - "IRR" - - "ISK" - - "JEP" - - "JMD" - - "JOD" - - "JPY" - - "KES" - - "KGS" - - "KHR" - - "KMF" - - "KPW" - - "KRW" - - "KWD" - - "KYD" - - "KZT" - - "LAK" - - "LBP" - - "LKR" - - "LRD" - - "LSL" - - "LTL" - - "LVL" - - "LYD" - - "MAD" - - "MDL" - - "MGA" - - "MKD" - - "MMK" - - "MNT" - - "MOP" - - "MRO" - - "MUR" - - "MVR" - - "MWK" - - "MXN" - - "MYR" - - "MZN" - - "NAD" - - "NGN" - - "NIO" - - "NOK" - - "NPR" - - "NZD" - - "OMR" - - "PAB" - - "PEN" - - "PGK" - - "PHP" - - "PKR" - - "PLN" - - "PYG" - - "QAR" - - "RON" - - "RSD" - - "RUB" - - "RWF" - - "SAR" - - "SBD" - - "SCR" - - "SDG" - - "SEK" - - "SGD" - - "SHP" - - "SLL" - - "SOS" - - "SPL" - - "SRD" - - "STD" - - "SVC" - - "SYP" - - "SZL" - - "THB" - - "TJS" - - "TMT" - - "TND" - - "TOP" - - "TRY" - - "TTD" - - "TVD" - - "TWD" - - "TZS" - - "UAH" - - "UGX" - - "USD" - - "UYU" - - "UZS" - - "VEF" - - "VND" - - "VUV" - - "WST" - - "XAF" - - "XCD" - - "XDR" - - "XOF" - - "XPF" - - "YER" - - "ZAR" - - "ZMW" - - "ZWD" - - "BTC" - parentAccountId: - type: "string" - format: "uuid" - isPaymentDelegatedToParent: - type: "boolean" + - "AED" + - "AFN" + - "ALL" + - "AMD" + - "ANG" + - "AOA" + - "ARS" + - "AUD" + - "AWG" + - "AZN" + - "BAM" + - "BBD" + - "BDT" + - "BGN" + - "BHD" + - "BIF" + - "BMD" + - "BND" + - "BOB" + - "BRL" + - "BSD" + - "BTN" + - "BWP" + - "BYR" + - "BZD" + - "CAD" + - "CDF" + - "CHF" + - "CLP" + - "CNY" + - "COP" + - "CRC" + - "CUC" + - "CUP" + - "CVE" + - "CZK" + - "DJF" + - "DKK" + - "DOP" + - "DZD" + - "EGP" + - "ERN" + - "ETB" + - "EUR" + - "FJD" + - "FKP" + - "GBP" + - "GEL" + - "GGP" + - "GHS" + - "GIP" + - "GMD" + - "GNF" + - "GTQ" + - "GYD" + - "HKD" + - "HNL" + - "HRK" + - "HTG" + - "HUF" + - "IDR" + - "ILS" + - "IMP" + - "INR" + - "IQD" + - "IRR" + - "ISK" + - "JEP" + - "JMD" + - "JOD" + - "JPY" + - "KES" + - "KGS" + - "KHR" + - "KMF" + - "KPW" + - "KRW" + - "KWD" + - "KYD" + - "KZT" + - "LAK" + - "LBP" + - "LKR" + - "LRD" + - "LSL" + - "LTL" + - "LVL" + - "LYD" + - "MAD" + - "MDL" + - "MGA" + - "MKD" + - "MMK" + - "MNT" + - "MOP" + - "MRO" + - "MUR" + - "MVR" + - "MWK" + - "MXN" + - "MYR" + - "MZN" + - "NAD" + - "NGN" + - "NIO" + - "NOK" + - "NPR" + - "NZD" + - "OMR" + - "PAB" + - "PEN" + - "PGK" + - "PHP" + - "PKR" + - "PLN" + - "PYG" + - "QAR" + - "RON" + - "RSD" + - "RUB" + - "RWF" + - "SAR" + - "SBD" + - "SCR" + - "SDG" + - "SEK" + - "SGD" + - "SHP" + - "SLL" + - "SOS" + - "SPL" + - "SRD" + - "STD" + - "SVC" + - "SYP" + - "SZL" + - "THB" + - "TJS" + - "TMT" + - "TND" + - "TOP" + - "TRY" + - "TTD" + - "TVD" + - "TWD" + - "TZS" + - "UAH" + - "UGX" + - "USD" + - "UYU" + - "UZS" + - "VEF" + - "VND" + - "VUV" + - "WST" + - "XAF" + - "XCD" + - "XDR" + - "XOF" + - "XPF" + - "YER" + - "ZAR" + - "ZMW" + - "ZWD" + - "BTC" paymentMethodId: type: "string" format: "uuid" - referenceTime: - type: "string" - format: "date-time" - timeZone: - type: "string" - address1: - type: "string" - address2: - type: "string" - postalCode: - type: "string" - company: - type: "string" - city: - type: "string" - state: - type: "string" - country: - type: "string" - locale: - type: "string" - phone: - type: "string" - notes: - type: "string" - isMigrated: - type: "boolean" - accountBalance: - type: "number" - accountCBA: - type: "number" - auditLogs: - type: "array" - items: - $ref: "#/definitions/AuditLog" - AccountTimeline: - type: "object" - properties: - account: - $ref: "#/definitions/Account" - bundles: + transactions: type: "array" items: - $ref: "#/definitions/Bundle" - invoices: + $ref: "#/definitions/PaymentTransaction" + paymentAttempts: type: "array" items: - $ref: "#/definitions/Invoice" - payments: + $ref: "#/definitions/PaymentAttempt" + auditLogs: type: "array" items: - $ref: "#/definitions/InvoicePayment" - InvoicePayment: + $ref: "#/definitions/AuditLog" + AdminPayment: type: "object" properties: - targetInvoiceId: + lastSuccessPaymentState: type: "string" - format: "uuid" - accountId: + currentPaymentStateName: type: "string" - format: "uuid" - paymentId: + transactionStatus: type: "string" - format: "uuid" - paymentNumber: + SimplePlan: + type: "object" + properties: + planId: type: "string" - paymentExternalKey: + productName: type: "string" - authAmount: - type: "number" - capturedAmount: - type: "number" - purchasedAmount: - type: "number" - refundedAmount: - type: "number" - creditedAmount: - type: "number" + productCategory: + type: "string" + enum: + - "BASE" + - "ADD_ON" + - "STANDALONE" currency: type: "string" enum: - - "AED" - - "AFN" - - "ALL" - - "AMD" - - "ANG" - - "AOA" - - "ARS" - - "AUD" - - "AWG" - - "AZN" - - "BAM" - - "BBD" - - "BDT" - - "BGN" - - "BHD" - - "BIF" - - "BMD" - - "BND" - - "BOB" - - "BRL" - - "BSD" - - "BTN" - - "BWP" - - "BYR" - - "BZD" - - "CAD" - - "CDF" - - "CHF" - - "CLP" - - "CNY" - - "COP" - - "CRC" - - "CUC" - - "CUP" - - "CVE" - - "CZK" - - "DJF" - - "DKK" - - "DOP" - - "DZD" - - "EGP" - - "ERN" - - "ETB" - - "EUR" - - "FJD" - - "FKP" - - "GBP" - - "GEL" - - "GGP" - - "GHS" - - "GIP" - - "GMD" - - "GNF" - - "GTQ" - - "GYD" - - "HKD" - - "HNL" - - "HRK" - - "HTG" - - "HUF" - - "IDR" - - "ILS" - - "IMP" - - "INR" - - "IQD" - - "IRR" - - "ISK" - - "JEP" - - "JMD" - - "JOD" - - "JPY" - - "KES" - - "KGS" - - "KHR" - - "KMF" - - "KPW" - - "KRW" - - "KWD" - - "KYD" - - "KZT" - - "LAK" - - "LBP" - - "LKR" - - "LRD" - - "LSL" - - "LTL" - - "LVL" - - "LYD" - - "MAD" - - "MDL" - - "MGA" - - "MKD" - - "MMK" - - "MNT" - - "MOP" - - "MRO" - - "MUR" - - "MVR" - - "MWK" - - "MXN" - - "MYR" - - "MZN" - - "NAD" - - "NGN" - - "NIO" - - "NOK" - - "NPR" - - "NZD" - - "OMR" - - "PAB" - - "PEN" - - "PGK" - - "PHP" - - "PKR" - - "PLN" - - "PYG" - - "QAR" - - "RON" - - "RSD" - - "RUB" - - "RWF" - - "SAR" - - "SBD" - - "SCR" - - "SDG" - - "SEK" - - "SGD" - - "SHP" - - "SLL" - - "SOS" - - "SPL" - - "SRD" - - "STD" - - "SVC" - - "SYP" - - "SZL" - - "THB" - - "TJS" - - "TMT" - - "TND" - - "TOP" - - "TRY" - - "TTD" - - "TVD" - - "TWD" - - "TZS" - - "UAH" - - "UGX" - - "USD" - - "UYU" - - "UZS" - - "VEF" - - "VND" - - "VUV" - - "WST" - - "XAF" - - "XCD" - - "XDR" - - "XOF" - - "XPF" - - "YER" - - "ZAR" - - "ZMW" - - "ZWD" - - "BTC" - paymentMethodId: - type: "string" - format: "uuid" - transactions: - type: "array" - items: - $ref: "#/definitions/PaymentTransaction" - paymentAttempts: - type: "array" - items: - $ref: "#/definitions/PaymentAttempt" - auditLogs: + - "AED" + - "AFN" + - "ALL" + - "AMD" + - "ANG" + - "AOA" + - "ARS" + - "AUD" + - "AWG" + - "AZN" + - "BAM" + - "BBD" + - "BDT" + - "BGN" + - "BHD" + - "BIF" + - "BMD" + - "BND" + - "BOB" + - "BRL" + - "BSD" + - "BTN" + - "BWP" + - "BYR" + - "BZD" + - "CAD" + - "CDF" + - "CHF" + - "CLP" + - "CNY" + - "COP" + - "CRC" + - "CUC" + - "CUP" + - "CVE" + - "CZK" + - "DJF" + - "DKK" + - "DOP" + - "DZD" + - "EGP" + - "ERN" + - "ETB" + - "EUR" + - "FJD" + - "FKP" + - "GBP" + - "GEL" + - "GGP" + - "GHS" + - "GIP" + - "GMD" + - "GNF" + - "GTQ" + - "GYD" + - "HKD" + - "HNL" + - "HRK" + - "HTG" + - "HUF" + - "IDR" + - "ILS" + - "IMP" + - "INR" + - "IQD" + - "IRR" + - "ISK" + - "JEP" + - "JMD" + - "JOD" + - "JPY" + - "KES" + - "KGS" + - "KHR" + - "KMF" + - "KPW" + - "KRW" + - "KWD" + - "KYD" + - "KZT" + - "LAK" + - "LBP" + - "LKR" + - "LRD" + - "LSL" + - "LTL" + - "LVL" + - "LYD" + - "MAD" + - "MDL" + - "MGA" + - "MKD" + - "MMK" + - "MNT" + - "MOP" + - "MRO" + - "MUR" + - "MVR" + - "MWK" + - "MXN" + - "MYR" + - "MZN" + - "NAD" + - "NGN" + - "NIO" + - "NOK" + - "NPR" + - "NZD" + - "OMR" + - "PAB" + - "PEN" + - "PGK" + - "PHP" + - "PKR" + - "PLN" + - "PYG" + - "QAR" + - "RON" + - "RSD" + - "RUB" + - "RWF" + - "SAR" + - "SBD" + - "SCR" + - "SDG" + - "SEK" + - "SGD" + - "SHP" + - "SLL" + - "SOS" + - "SPL" + - "SRD" + - "STD" + - "SVC" + - "SYP" + - "SZL" + - "THB" + - "TJS" + - "TMT" + - "TND" + - "TOP" + - "TRY" + - "TTD" + - "TVD" + - "TWD" + - "TZS" + - "UAH" + - "UGX" + - "USD" + - "UYU" + - "UZS" + - "VEF" + - "VND" + - "VUV" + - "WST" + - "XAF" + - "XCD" + - "XDR" + - "XOF" + - "XPF" + - "YER" + - "ZAR" + - "ZMW" + - "ZWD" + - "BTC" + amount: + type: "number" + billingPeriod: + type: "string" + enum: + - "DAILY" + - "WEEKLY" + - "BIWEEKLY" + - "THIRTY_DAYS" + - "THIRTY_ONE_DAYS" + - "SIXTY_DAYS" + - "NINETY_DAYS" + - "MONTHLY" + - "BIMESTRIAL" + - "QUARTERLY" + - "TRIANNUAL" + - "BIANNUAL" + - "ANNUAL" + - "SESQUIENNIAL" + - "BIENNIAL" + - "TRIENNIAL" + - "NO_BILLING_PERIOD" + trialLength: + type: "integer" + format: "int32" + trialTimeUnit: + type: "string" + enum: + - "DAYS" + - "WEEKS" + - "MONTHS" + - "YEARS" + - "UNLIMITED" + availableBaseProducts: type: "array" items: - $ref: "#/definitions/AuditLog" - AccountEmail: + type: "string" + PlanDetail: type: "object" - required: - - "email" properties: - accountId: + product: type: "string" - format: "uuid" - email: + plan: type: "string" - auditLogs: + priceList: + type: "string" + finalPhaseBillingPeriod: + type: "string" + enum: + - "DAILY" + - "WEEKLY" + - "BIWEEKLY" + - "THIRTY_DAYS" + - "THIRTY_ONE_DAYS" + - "SIXTY_DAYS" + - "NINETY_DAYS" + - "MONTHLY" + - "BIMESTRIAL" + - "QUARTERLY" + - "TRIANNUAL" + - "BIANNUAL" + - "ANNUAL" + - "SESQUIENNIAL" + - "BIENNIAL" + - "TRIENNIAL" + - "NO_BILLING_PERIOD" + finalPhaseRecurringPrice: type: "array" items: - $ref: "#/definitions/AuditLog" - AdminPayment: + $ref: "#/definitions/Price" + Price: type: "object" properties: - lastSuccessPaymentState: + currency: type: "string" - currentPaymentStateName: + enum: + - "AED" + - "AFN" + - "ALL" + - "AMD" + - "ANG" + - "AOA" + - "ARS" + - "AUD" + - "AWG" + - "AZN" + - "BAM" + - "BBD" + - "BDT" + - "BGN" + - "BHD" + - "BIF" + - "BMD" + - "BND" + - "BOB" + - "BRL" + - "BSD" + - "BTN" + - "BWP" + - "BYR" + - "BZD" + - "CAD" + - "CDF" + - "CHF" + - "CLP" + - "CNY" + - "COP" + - "CRC" + - "CUC" + - "CUP" + - "CVE" + - "CZK" + - "DJF" + - "DKK" + - "DOP" + - "DZD" + - "EGP" + - "ERN" + - "ETB" + - "EUR" + - "FJD" + - "FKP" + - "GBP" + - "GEL" + - "GGP" + - "GHS" + - "GIP" + - "GMD" + - "GNF" + - "GTQ" + - "GYD" + - "HKD" + - "HNL" + - "HRK" + - "HTG" + - "HUF" + - "IDR" + - "ILS" + - "IMP" + - "INR" + - "IQD" + - "IRR" + - "ISK" + - "JEP" + - "JMD" + - "JOD" + - "JPY" + - "KES" + - "KGS" + - "KHR" + - "KMF" + - "KPW" + - "KRW" + - "KWD" + - "KYD" + - "KZT" + - "LAK" + - "LBP" + - "LKR" + - "LRD" + - "LSL" + - "LTL" + - "LVL" + - "LYD" + - "MAD" + - "MDL" + - "MGA" + - "MKD" + - "MMK" + - "MNT" + - "MOP" + - "MRO" + - "MUR" + - "MVR" + - "MWK" + - "MXN" + - "MYR" + - "MZN" + - "NAD" + - "NGN" + - "NIO" + - "NOK" + - "NPR" + - "NZD" + - "OMR" + - "PAB" + - "PEN" + - "PGK" + - "PHP" + - "PKR" + - "PLN" + - "PYG" + - "QAR" + - "RON" + - "RSD" + - "RUB" + - "RWF" + - "SAR" + - "SBD" + - "SCR" + - "SDG" + - "SEK" + - "SGD" + - "SHP" + - "SLL" + - "SOS" + - "SPL" + - "SRD" + - "STD" + - "SVC" + - "SYP" + - "SZL" + - "THB" + - "TJS" + - "TMT" + - "TND" + - "TOP" + - "TRY" + - "TTD" + - "TVD" + - "TWD" + - "TZS" + - "UAH" + - "UGX" + - "USD" + - "UYU" + - "UZS" + - "VEF" + - "VND" + - "VUV" + - "WST" + - "XAF" + - "XCD" + - "XDR" + - "XOF" + - "XPF" + - "YER" + - "ZAR" + - "ZMW" + - "ZWD" + - "BTC" + value: + type: "number" + Catalog: + type: "object" + properties: + name: type: "string" - transactionStatus: + effectiveDate: type: "string" + format: "date-time" + currencies: + type: "array" + items: + type: "string" + enum: + - "AED" + - "AFN" + - "ALL" + - "AMD" + - "ANG" + - "AOA" + - "ARS" + - "AUD" + - "AWG" + - "AZN" + - "BAM" + - "BBD" + - "BDT" + - "BGN" + - "BHD" + - "BIF" + - "BMD" + - "BND" + - "BOB" + - "BRL" + - "BSD" + - "BTN" + - "BWP" + - "BYR" + - "BZD" + - "CAD" + - "CDF" + - "CHF" + - "CLP" + - "CNY" + - "COP" + - "CRC" + - "CUC" + - "CUP" + - "CVE" + - "CZK" + - "DJF" + - "DKK" + - "DOP" + - "DZD" + - "EGP" + - "ERN" + - "ETB" + - "EUR" + - "FJD" + - "FKP" + - "GBP" + - "GEL" + - "GGP" + - "GHS" + - "GIP" + - "GMD" + - "GNF" + - "GTQ" + - "GYD" + - "HKD" + - "HNL" + - "HRK" + - "HTG" + - "HUF" + - "IDR" + - "ILS" + - "IMP" + - "INR" + - "IQD" + - "IRR" + - "ISK" + - "JEP" + - "JMD" + - "JOD" + - "JPY" + - "KES" + - "KGS" + - "KHR" + - "KMF" + - "KPW" + - "KRW" + - "KWD" + - "KYD" + - "KZT" + - "LAK" + - "LBP" + - "LKR" + - "LRD" + - "LSL" + - "LTL" + - "LVL" + - "LYD" + - "MAD" + - "MDL" + - "MGA" + - "MKD" + - "MMK" + - "MNT" + - "MOP" + - "MRO" + - "MUR" + - "MVR" + - "MWK" + - "MXN" + - "MYR" + - "MZN" + - "NAD" + - "NGN" + - "NIO" + - "NOK" + - "NPR" + - "NZD" + - "OMR" + - "PAB" + - "PEN" + - "PGK" + - "PHP" + - "PKR" + - "PLN" + - "PYG" + - "QAR" + - "RON" + - "RSD" + - "RUB" + - "RWF" + - "SAR" + - "SBD" + - "SCR" + - "SDG" + - "SEK" + - "SGD" + - "SHP" + - "SLL" + - "SOS" + - "SPL" + - "SRD" + - "STD" + - "SVC" + - "SYP" + - "SZL" + - "THB" + - "TJS" + - "TMT" + - "TND" + - "TOP" + - "TRY" + - "TTD" + - "TVD" + - "TWD" + - "TZS" + - "UAH" + - "UGX" + - "USD" + - "UYU" + - "UZS" + - "VEF" + - "VND" + - "VUV" + - "WST" + - "XAF" + - "XCD" + - "XDR" + - "XOF" + - "XPF" + - "YER" + - "ZAR" + - "ZMW" + - "ZWD" + - "BTC" + units: + type: "array" + items: + $ref: "#/definitions/Unit" + products: + type: "array" + items: + $ref: "#/definitions/Product" + priceLists: + type: "array" + items: + $ref: "#/definitions/PriceList" Duration: type: "object" properties: unit: type: "string" enum: - - "DAYS" - - "WEEKS" - - "MONTHS" - - "YEARS" - - "UNLIMITED" + - "DAYS" + - "WEEKS" + - "MONTHS" + - "YEARS" + - "UNLIMITED" number: type: "integer" format: "int32" @@ -14211,208 +14825,65 @@ definitions: type: "string" prettyName: type: "string" - recurringBillingMode: - type: "string" - enum: - - "IN_ADVANCE" - - "IN_ARREAR" - billingPeriod: - type: "string" - enum: - - "DAILY" - - "WEEKLY" - - "BIWEEKLY" - - "THIRTY_DAYS" - - "THIRTY_ONE_DAYS" - - "SIXTY_DAYS" - - "NINETY_DAYS" - - "MONTHLY" - - "BIMESTRIAL" - - "QUARTERLY" - - "TRIANNUAL" - - "BIANNUAL" - - "ANNUAL" - - "SESQUIENNIAL" - - "BIENNIAL" - - "TRIENNIAL" - - "NO_BILLING_PERIOD" - phases: + recurringBillingMode: + type: "string" + enum: + - "IN_ADVANCE" + - "IN_ARREAR" + billingPeriod: + type: "string" + enum: + - "DAILY" + - "WEEKLY" + - "BIWEEKLY" + - "THIRTY_DAYS" + - "THIRTY_ONE_DAYS" + - "SIXTY_DAYS" + - "NINETY_DAYS" + - "MONTHLY" + - "BIMESTRIAL" + - "QUARTERLY" + - "TRIANNUAL" + - "BIANNUAL" + - "ANNUAL" + - "SESQUIENNIAL" + - "BIENNIAL" + - "TRIENNIAL" + - "NO_BILLING_PERIOD" + phases: + type: "array" + items: + $ref: "#/definitions/Phase" + PriceList: + type: "object" + properties: + name: + type: "string" + plans: + type: "array" + items: + type: "string" + Product: + type: "object" + properties: + type: + type: "string" + name: + type: "string" + prettyName: + type: "string" + plans: type: "array" items: - $ref: "#/definitions/Phase" - Price: - type: "object" - properties: - currency: - type: "string" - enum: - - "AED" - - "AFN" - - "ALL" - - "AMD" - - "ANG" - - "AOA" - - "ARS" - - "AUD" - - "AWG" - - "AZN" - - "BAM" - - "BBD" - - "BDT" - - "BGN" - - "BHD" - - "BIF" - - "BMD" - - "BND" - - "BOB" - - "BRL" - - "BSD" - - "BTN" - - "BWP" - - "BYR" - - "BZD" - - "CAD" - - "CDF" - - "CHF" - - "CLP" - - "CNY" - - "COP" - - "CRC" - - "CUC" - - "CUP" - - "CVE" - - "CZK" - - "DJF" - - "DKK" - - "DOP" - - "DZD" - - "EGP" - - "ERN" - - "ETB" - - "EUR" - - "FJD" - - "FKP" - - "GBP" - - "GEL" - - "GGP" - - "GHS" - - "GIP" - - "GMD" - - "GNF" - - "GTQ" - - "GYD" - - "HKD" - - "HNL" - - "HRK" - - "HTG" - - "HUF" - - "IDR" - - "ILS" - - "IMP" - - "INR" - - "IQD" - - "IRR" - - "ISK" - - "JEP" - - "JMD" - - "JOD" - - "JPY" - - "KES" - - "KGS" - - "KHR" - - "KMF" - - "KPW" - - "KRW" - - "KWD" - - "KYD" - - "KZT" - - "LAK" - - "LBP" - - "LKR" - - "LRD" - - "LSL" - - "LTL" - - "LVL" - - "LYD" - - "MAD" - - "MDL" - - "MGA" - - "MKD" - - "MMK" - - "MNT" - - "MOP" - - "MRO" - - "MUR" - - "MVR" - - "MWK" - - "MXN" - - "MYR" - - "MZN" - - "NAD" - - "NGN" - - "NIO" - - "NOK" - - "NPR" - - "NZD" - - "OMR" - - "PAB" - - "PEN" - - "PGK" - - "PHP" - - "PKR" - - "PLN" - - "PYG" - - "QAR" - - "RON" - - "RSD" - - "RUB" - - "RWF" - - "SAR" - - "SBD" - - "SCR" - - "SDG" - - "SEK" - - "SGD" - - "SHP" - - "SLL" - - "SOS" - - "SPL" - - "SRD" - - "STD" - - "SVC" - - "SYP" - - "SZL" - - "THB" - - "TJS" - - "TMT" - - "TND" - - "TOP" - - "TRY" - - "TTD" - - "TVD" - - "TWD" - - "TZS" - - "UAH" - - "UGX" - - "USD" - - "UYU" - - "UZS" - - "VEF" - - "VND" - - "VUV" - - "WST" - - "XAF" - - "XCD" - - "XDR" - - "XOF" - - "XPF" - - "YER" - - "ZAR" - - "ZMW" - - "ZWD" - - "BTC" - value: - type: "number" + $ref: "#/definitions/Plan" + included: + type: "array" + items: + type: "string" + available: + type: "array" + items: + type: "string" Tier: type: "object" properties: @@ -14445,6 +14916,13 @@ definitions: type: "array" items: $ref: "#/definitions/Price" + Unit: + type: "object" + properties: + name: + type: "string" + prettyName: + type: "string" Usage: type: "object" properties: @@ -14454,49 +14932,222 @@ definitions: type: "array" items: $ref: "#/definitions/Tier" - Product: + CatalogValidation: type: "object" properties: - type: - type: "string" - name: - type: "string" - prettyName: - type: "string" - plans: - type: "array" - items: - $ref: "#/definitions/Plan" - included: - type: "array" - items: - type: "string" - available: + catalogValidationErrors: type: "array" items: - type: "string" - PriceList: + $ref: "#/definitions/CatalogValidationError" + CatalogValidationError: type: "object" properties: - name: + errorDescription: type: "string" - plans: - type: "array" - items: - type: "string" - Catalog: + InvoicePaymentTransaction: type: "object" properties: - name: + transactionId: + type: "string" + format: "uuid" + transactionExternalKey: + type: "string" + paymentId: + type: "string" + format: "uuid" + description: "Associated payment id, required when notifying state transitions" + paymentExternalKey: + type: "string" + transactionType: type: "string" + enum: + - "AUTHORIZE" + - "CAPTURE" + - "CHARGEBACK" + - "CREDIT" + - "PURCHASE" + - "REFUND" + - "VOID" + amount: + type: "number" + description: "Transaction amount, required except for void operations" + currency: + type: "string" + description: "Amount currency (account currency unless specified)" + enum: + - "AED" + - "AFN" + - "ALL" + - "AMD" + - "ANG" + - "AOA" + - "ARS" + - "AUD" + - "AWG" + - "AZN" + - "BAM" + - "BBD" + - "BDT" + - "BGN" + - "BHD" + - "BIF" + - "BMD" + - "BND" + - "BOB" + - "BRL" + - "BSD" + - "BTN" + - "BWP" + - "BYR" + - "BZD" + - "CAD" + - "CDF" + - "CHF" + - "CLP" + - "CNY" + - "COP" + - "CRC" + - "CUC" + - "CUP" + - "CVE" + - "CZK" + - "DJF" + - "DKK" + - "DOP" + - "DZD" + - "EGP" + - "ERN" + - "ETB" + - "EUR" + - "FJD" + - "FKP" + - "GBP" + - "GEL" + - "GGP" + - "GHS" + - "GIP" + - "GMD" + - "GNF" + - "GTQ" + - "GYD" + - "HKD" + - "HNL" + - "HRK" + - "HTG" + - "HUF" + - "IDR" + - "ILS" + - "IMP" + - "INR" + - "IQD" + - "IRR" + - "ISK" + - "JEP" + - "JMD" + - "JOD" + - "JPY" + - "KES" + - "KGS" + - "KHR" + - "KMF" + - "KPW" + - "KRW" + - "KWD" + - "KYD" + - "KZT" + - "LAK" + - "LBP" + - "LKR" + - "LRD" + - "LSL" + - "LTL" + - "LVL" + - "LYD" + - "MAD" + - "MDL" + - "MGA" + - "MKD" + - "MMK" + - "MNT" + - "MOP" + - "MRO" + - "MUR" + - "MVR" + - "MWK" + - "MXN" + - "MYR" + - "MZN" + - "NAD" + - "NGN" + - "NIO" + - "NOK" + - "NPR" + - "NZD" + - "OMR" + - "PAB" + - "PEN" + - "PGK" + - "PHP" + - "PKR" + - "PLN" + - "PYG" + - "QAR" + - "RON" + - "RSD" + - "RUB" + - "RWF" + - "SAR" + - "SBD" + - "SCR" + - "SDG" + - "SEK" + - "SGD" + - "SHP" + - "SLL" + - "SOS" + - "SPL" + - "SRD" + - "STD" + - "SVC" + - "SYP" + - "SZL" + - "THB" + - "TJS" + - "TMT" + - "TND" + - "TOP" + - "TRY" + - "TTD" + - "TVD" + - "TWD" + - "TZS" + - "UAH" + - "UGX" + - "USD" + - "UYU" + - "UZS" + - "VEF" + - "VND" + - "VUV" + - "WST" + - "XAF" + - "XCD" + - "XDR" + - "XOF" + - "XPF" + - "YER" + - "ZAR" + - "ZMW" + - "ZWD" + - "BTC" effectiveDate: type: "string" - format: "date-time" - currencies: - type: "array" - items: - type: "string" - enum: + format: "date-time" + processedAmount: + type: "number" + processedCurrency: + type: "string" + enum: - "AED" - "AFN" - "ALL" @@ -14662,667 +15313,16 @@ definitions: - "ZMW" - "ZWD" - "BTC" - units: - type: "array" - items: - $ref: "#/definitions/Unit" - products: - type: "array" - items: - $ref: "#/definitions/Product" - priceLists: - type: "array" - items: - $ref: "#/definitions/PriceList" - Unit: - type: "object" - properties: - name: - type: "string" - prettyName: - type: "string" - CatalogValidation: - type: "object" - properties: - catalogValidationErrors: - type: "array" - items: - $ref: "#/definitions/CatalogValidationError" - CatalogValidationError: - type: "object" - properties: - errorDescription: - type: "string" - PlanDetail: - type: "object" - properties: - product: - type: "string" - plan: - type: "string" - priceList: - type: "string" - finalPhaseBillingPeriod: - type: "string" - enum: - - "DAILY" - - "WEEKLY" - - "BIWEEKLY" - - "THIRTY_DAYS" - - "THIRTY_ONE_DAYS" - - "SIXTY_DAYS" - - "NINETY_DAYS" - - "MONTHLY" - - "BIMESTRIAL" - - "QUARTERLY" - - "TRIANNUAL" - - "BIANNUAL" - - "ANNUAL" - - "SESQUIENNIAL" - - "BIENNIAL" - - "TRIENNIAL" - - "NO_BILLING_PERIOD" - finalPhaseRecurringPrice: - type: "array" - items: - $ref: "#/definitions/Price" - SimplePlan: - type: "object" - properties: - planId: - type: "string" - productName: - type: "string" - productCategory: - type: "string" - enum: - - "BASE" - - "ADD_ON" - - "STANDALONE" - currency: - type: "string" - enum: - - "AED" - - "AFN" - - "ALL" - - "AMD" - - "ANG" - - "AOA" - - "ARS" - - "AUD" - - "AWG" - - "AZN" - - "BAM" - - "BBD" - - "BDT" - - "BGN" - - "BHD" - - "BIF" - - "BMD" - - "BND" - - "BOB" - - "BRL" - - "BSD" - - "BTN" - - "BWP" - - "BYR" - - "BZD" - - "CAD" - - "CDF" - - "CHF" - - "CLP" - - "CNY" - - "COP" - - "CRC" - - "CUC" - - "CUP" - - "CVE" - - "CZK" - - "DJF" - - "DKK" - - "DOP" - - "DZD" - - "EGP" - - "ERN" - - "ETB" - - "EUR" - - "FJD" - - "FKP" - - "GBP" - - "GEL" - - "GGP" - - "GHS" - - "GIP" - - "GMD" - - "GNF" - - "GTQ" - - "GYD" - - "HKD" - - "HNL" - - "HRK" - - "HTG" - - "HUF" - - "IDR" - - "ILS" - - "IMP" - - "INR" - - "IQD" - - "IRR" - - "ISK" - - "JEP" - - "JMD" - - "JOD" - - "JPY" - - "KES" - - "KGS" - - "KHR" - - "KMF" - - "KPW" - - "KRW" - - "KWD" - - "KYD" - - "KZT" - - "LAK" - - "LBP" - - "LKR" - - "LRD" - - "LSL" - - "LTL" - - "LVL" - - "LYD" - - "MAD" - - "MDL" - - "MGA" - - "MKD" - - "MMK" - - "MNT" - - "MOP" - - "MRO" - - "MUR" - - "MVR" - - "MWK" - - "MXN" - - "MYR" - - "MZN" - - "NAD" - - "NGN" - - "NIO" - - "NOK" - - "NPR" - - "NZD" - - "OMR" - - "PAB" - - "PEN" - - "PGK" - - "PHP" - - "PKR" - - "PLN" - - "PYG" - - "QAR" - - "RON" - - "RSD" - - "RUB" - - "RWF" - - "SAR" - - "SBD" - - "SCR" - - "SDG" - - "SEK" - - "SGD" - - "SHP" - - "SLL" - - "SOS" - - "SPL" - - "SRD" - - "STD" - - "SVC" - - "SYP" - - "SZL" - - "THB" - - "TJS" - - "TMT" - - "TND" - - "TOP" - - "TRY" - - "TTD" - - "TVD" - - "TWD" - - "TZS" - - "UAH" - - "UGX" - - "USD" - - "UYU" - - "UZS" - - "VEF" - - "VND" - - "VUV" - - "WST" - - "XAF" - - "XCD" - - "XDR" - - "XOF" - - "XPF" - - "YER" - - "ZAR" - - "ZMW" - - "ZWD" - - "BTC" - amount: - type: "number" - billingPeriod: - type: "string" - enum: - - "DAILY" - - "WEEKLY" - - "BIWEEKLY" - - "THIRTY_DAYS" - - "THIRTY_ONE_DAYS" - - "SIXTY_DAYS" - - "NINETY_DAYS" - - "MONTHLY" - - "BIMESTRIAL" - - "QUARTERLY" - - "TRIANNUAL" - - "BIANNUAL" - - "ANNUAL" - - "SESQUIENNIAL" - - "BIENNIAL" - - "TRIENNIAL" - - "NO_BILLING_PERIOD" - trialLength: - type: "integer" - format: "int32" - trialTimeUnit: - type: "string" - enum: - - "DAYS" - - "WEEKS" - - "MONTHS" - - "YEARS" - - "UNLIMITED" - availableBaseProducts: - type: "array" - items: - type: "string" - InvoicePaymentTransaction: - type: "object" - properties: - transactionId: - type: "string" - format: "uuid" - transactionExternalKey: - type: "string" - paymentId: - type: "string" - format: "uuid" - description: "Associated payment id, required when notifying state transitions" - paymentExternalKey: - type: "string" - transactionType: - type: "string" - enum: - - "AUTHORIZE" - - "CAPTURE" - - "CHARGEBACK" - - "CREDIT" - - "PURCHASE" - - "REFUND" - - "VOID" - amount: - type: "number" - description: "Transaction amount, required except for void operations" - currency: - type: "string" - description: "Amount currency (account currency unless specified)" - enum: - - "AED" - - "AFN" - - "ALL" - - "AMD" - - "ANG" - - "AOA" - - "ARS" - - "AUD" - - "AWG" - - "AZN" - - "BAM" - - "BBD" - - "BDT" - - "BGN" - - "BHD" - - "BIF" - - "BMD" - - "BND" - - "BOB" - - "BRL" - - "BSD" - - "BTN" - - "BWP" - - "BYR" - - "BZD" - - "CAD" - - "CDF" - - "CHF" - - "CLP" - - "CNY" - - "COP" - - "CRC" - - "CUC" - - "CUP" - - "CVE" - - "CZK" - - "DJF" - - "DKK" - - "DOP" - - "DZD" - - "EGP" - - "ERN" - - "ETB" - - "EUR" - - "FJD" - - "FKP" - - "GBP" - - "GEL" - - "GGP" - - "GHS" - - "GIP" - - "GMD" - - "GNF" - - "GTQ" - - "GYD" - - "HKD" - - "HNL" - - "HRK" - - "HTG" - - "HUF" - - "IDR" - - "ILS" - - "IMP" - - "INR" - - "IQD" - - "IRR" - - "ISK" - - "JEP" - - "JMD" - - "JOD" - - "JPY" - - "KES" - - "KGS" - - "KHR" - - "KMF" - - "KPW" - - "KRW" - - "KWD" - - "KYD" - - "KZT" - - "LAK" - - "LBP" - - "LKR" - - "LRD" - - "LSL" - - "LTL" - - "LVL" - - "LYD" - - "MAD" - - "MDL" - - "MGA" - - "MKD" - - "MMK" - - "MNT" - - "MOP" - - "MRO" - - "MUR" - - "MVR" - - "MWK" - - "MXN" - - "MYR" - - "MZN" - - "NAD" - - "NGN" - - "NIO" - - "NOK" - - "NPR" - - "NZD" - - "OMR" - - "PAB" - - "PEN" - - "PGK" - - "PHP" - - "PKR" - - "PLN" - - "PYG" - - "QAR" - - "RON" - - "RSD" - - "RUB" - - "RWF" - - "SAR" - - "SBD" - - "SCR" - - "SDG" - - "SEK" - - "SGD" - - "SHP" - - "SLL" - - "SOS" - - "SPL" - - "SRD" - - "STD" - - "SVC" - - "SYP" - - "SZL" - - "THB" - - "TJS" - - "TMT" - - "TND" - - "TOP" - - "TRY" - - "TTD" - - "TVD" - - "TWD" - - "TZS" - - "UAH" - - "UGX" - - "USD" - - "UYU" - - "UZS" - - "VEF" - - "VND" - - "VUV" - - "WST" - - "XAF" - - "XCD" - - "XDR" - - "XOF" - - "XPF" - - "YER" - - "ZAR" - - "ZMW" - - "ZWD" - - "BTC" - effectiveDate: - type: "string" - format: "date-time" - processedAmount: - type: "number" - processedCurrency: - type: "string" - enum: - - "AED" - - "AFN" - - "ALL" - - "AMD" - - "ANG" - - "AOA" - - "ARS" - - "AUD" - - "AWG" - - "AZN" - - "BAM" - - "BBD" - - "BDT" - - "BGN" - - "BHD" - - "BIF" - - "BMD" - - "BND" - - "BOB" - - "BRL" - - "BSD" - - "BTN" - - "BWP" - - "BYR" - - "BZD" - - "CAD" - - "CDF" - - "CHF" - - "CLP" - - "CNY" - - "COP" - - "CRC" - - "CUC" - - "CUP" - - "CVE" - - "CZK" - - "DJF" - - "DKK" - - "DOP" - - "DZD" - - "EGP" - - "ERN" - - "ETB" - - "EUR" - - "FJD" - - "FKP" - - "GBP" - - "GEL" - - "GGP" - - "GHS" - - "GIP" - - "GMD" - - "GNF" - - "GTQ" - - "GYD" - - "HKD" - - "HNL" - - "HRK" - - "HTG" - - "HUF" - - "IDR" - - "ILS" - - "IMP" - - "INR" - - "IQD" - - "IRR" - - "ISK" - - "JEP" - - "JMD" - - "JOD" - - "JPY" - - "KES" - - "KGS" - - "KHR" - - "KMF" - - "KPW" - - "KRW" - - "KWD" - - "KYD" - - "KZT" - - "LAK" - - "LBP" - - "LKR" - - "LRD" - - "LSL" - - "LTL" - - "LVL" - - "LYD" - - "MAD" - - "MDL" - - "MGA" - - "MKD" - - "MMK" - - "MNT" - - "MOP" - - "MRO" - - "MUR" - - "MVR" - - "MWK" - - "MXN" - - "MYR" - - "MZN" - - "NAD" - - "NGN" - - "NIO" - - "NOK" - - "NPR" - - "NZD" - - "OMR" - - "PAB" - - "PEN" - - "PGK" - - "PHP" - - "PKR" - - "PLN" - - "PYG" - - "QAR" - - "RON" - - "RSD" - - "RUB" - - "RWF" - - "SAR" - - "SBD" - - "SCR" - - "SDG" - - "SEK" - - "SGD" - - "SHP" - - "SLL" - - "SOS" - - "SPL" - - "SRD" - - "STD" - - "SVC" - - "SYP" - - "SZL" - - "THB" - - "TJS" - - "TMT" - - "TND" - - "TOP" - - "TRY" - - "TTD" - - "TVD" - - "TWD" - - "TZS" - - "UAH" - - "UGX" - - "USD" - - "UYU" - - "UZS" - - "VEF" - - "VND" - - "VUV" - - "WST" - - "XAF" - - "XCD" - - "XDR" - - "XOF" - - "XPF" - - "YER" - - "ZAR" - - "ZMW" - - "ZWD" - - "BTC" status: type: "string" description: "Transaction status, required for state change notifications" enum: - - "SUCCESS" - - "UNKNOWN" - - "PENDING" - - "PAYMENT_FAILURE" - - "PLUGIN_FAILURE" - - "PAYMENT_SYSTEM_OFF" + - "SUCCESS" + - "UNKNOWN" + - "PENDING" + - "PAYMENT_FAILURE" + - "PLUGIN_FAILURE" + - "PAYMENT_SYSTEM_OFF" gatewayErrorCode: type: "string" gatewayErrorMsg: @@ -15351,58 +15351,58 @@ definitions: dryRunType: type: "string" enum: - - "TARGET_DATE" - - "UPCOMING_INVOICE" - - "SUBSCRIPTION_ACTION" + - "TARGET_DATE" + - "UPCOMING_INVOICE" + - "SUBSCRIPTION_ACTION" dryRunAction: type: "string" enum: - - "START_ENTITLEMENT" - - "START_BILLING" - - "PAUSE_ENTITLEMENT" - - "PAUSE_BILLING" - - "RESUME_ENTITLEMENT" - - "RESUME_BILLING" - - "PHASE" - - "CHANGE" - - "STOP_ENTITLEMENT" - - "STOP_BILLING" - - "SERVICE_STATE_CHANGE" + - "START_ENTITLEMENT" + - "START_BILLING" + - "PAUSE_ENTITLEMENT" + - "PAUSE_BILLING" + - "RESUME_ENTITLEMENT" + - "RESUME_BILLING" + - "PHASE" + - "CHANGE" + - "STOP_ENTITLEMENT" + - "STOP_BILLING" + - "SERVICE_STATE_CHANGE" phaseType: type: "string" enum: - - "TRIAL" - - "DISCOUNT" - - "FIXEDTERM" - - "EVERGREEN" + - "TRIAL" + - "DISCOUNT" + - "FIXEDTERM" + - "EVERGREEN" productName: type: "string" productCategory: type: "string" enum: - - "BASE" - - "ADD_ON" - - "STANDALONE" + - "BASE" + - "ADD_ON" + - "STANDALONE" billingPeriod: type: "string" enum: - - "DAILY" - - "WEEKLY" - - "BIWEEKLY" - - "THIRTY_DAYS" - - "THIRTY_ONE_DAYS" - - "SIXTY_DAYS" - - "NINETY_DAYS" - - "MONTHLY" - - "BIMESTRIAL" - - "QUARTERLY" - - "TRIANNUAL" - - "BIANNUAL" - - "ANNUAL" - - "SESQUIENNIAL" - - "BIENNIAL" - - "TRIENNIAL" - - "NO_BILLING_PERIOD" + - "DAILY" + - "WEEKLY" + - "BIWEEKLY" + - "THIRTY_DAYS" + - "THIRTY_ONE_DAYS" + - "SIXTY_DAYS" + - "NINETY_DAYS" + - "MONTHLY" + - "BIMESTRIAL" + - "QUARTERLY" + - "TRIANNUAL" + - "BIANNUAL" + - "ANNUAL" + - "SESQUIENNIAL" + - "BIENNIAL" + - "TRIENNIAL" + - "NO_BILLING_PERIOD" priceListName: type: "string" subscriptionId: @@ -15417,16 +15417,34 @@ definitions: billingPolicy: type: "string" enum: - - "START_OF_TERM" - - "END_OF_TERM" - - "IMMEDIATE" - - "ILLEGAL" + - "START_OF_TERM" + - "END_OF_TERM" + - "IMMEDIATE" + - "ILLEGAL" priceOverrides: type: "array" items: $ref: "#/definitions/PhasePrice" planName: type: "string" + NodeCommand: + type: "object" + properties: + isSystemCommandType: + type: "boolean" + nodeCommandType: + type: "string" + nodeCommandProperties: + type: "array" + items: + $ref: "#/definitions/NodeCommandProperty" + NodeCommandProperty: + type: "object" + properties: + key: + type: "string" + value: + type: "object" NodeInfo: type: "object" properties: @@ -15479,24 +15497,6 @@ definitions: type: "string" registrationName: type: "string" - NodeCommand: - type: "object" - properties: - isSystemCommandType: - type: "boolean" - nodeCommandType: - type: "string" - nodeCommandProperties: - type: "array" - items: - $ref: "#/definitions/NodeCommandProperty" - NodeCommandProperty: - type: "object" - properties: - key: - type: "string" - value: - type: "object" Overdue: type: "object" properties: @@ -15515,27 +15515,27 @@ definitions: controlTagInclusion: type: "string" enum: - - "AUTO_PAY_OFF" - - "AUTO_INVOICING_OFF" - - "OVERDUE_ENFORCEMENT_OFF" - - "WRITTEN_OFF" - - "MANUAL_PAY" - - "TEST" - - "PARTNER" - - "AUTO_INVOICING_DRAFT" - - "AUTO_INVOICING_REUSE_DRAFT" + - "AUTO_PAY_OFF" + - "AUTO_INVOICING_OFF" + - "OVERDUE_ENFORCEMENT_OFF" + - "WRITTEN_OFF" + - "MANUAL_PAY" + - "TEST" + - "PARTNER" + - "AUTO_INVOICING_DRAFT" + - "AUTO_INVOICING_REUSE_DRAFT" controlTagExclusion: type: "string" enum: - - "AUTO_PAY_OFF" - - "AUTO_INVOICING_OFF" - - "OVERDUE_ENFORCEMENT_OFF" - - "WRITTEN_OFF" - - "MANUAL_PAY" - - "TEST" - - "PARTNER" - - "AUTO_INVOICING_DRAFT" - - "AUTO_INVOICING_REUSE_DRAFT" + - "AUTO_PAY_OFF" + - "AUTO_INVOICING_OFF" + - "OVERDUE_ENFORCEMENT_OFF" + - "WRITTEN_OFF" + - "MANUAL_PAY" + - "TEST" + - "PARTNER" + - "AUTO_INVOICING_DRAFT" + - "AUTO_INVOICING_REUSE_DRAFT" numberOfUnpaidInvoicesEqualsOrExceeds: type: "integer" format: "int32" @@ -15544,16 +15544,16 @@ definitions: items: type: "string" enum: - - "INVALID_CARD" - - "EXPIRED_CARD" - - "LOST_OR_STOLEN_CARD" - - "DO_NOT_HONOR" - - "INSUFFICIENT_FUNDS" - - "DECLINE" - - "PROCESSING_ERROR" - - "INVALID_AMOUNT" - - "DUPLICATE_TRANSACTION" - - "OTHER" + - "INVALID_CARD" + - "EXPIRED_CARD" + - "LOST_OR_STOLEN_CARD" + - "DO_NOT_HONOR" + - "INSUFFICIENT_FUNDS" + - "DECLINE" + - "PROCESSING_ERROR" + - "INVALID_AMOUNT" + - "DUPLICATE_TRANSACTION" + - "OTHER" totalUnpaidInvoiceBalanceEqualsOrExceeds: type: "number" OverdueStateConfig: @@ -15574,9 +15574,9 @@ definitions: subscriptionCancellationPolicy: type: "string" enum: - - "END_OF_TERM" - - "IMMEDIATE" - - "NONE" + - "END_OF_TERM" + - "IMMEDIATE" + - "NONE" autoReevaluationIntervalDays: type: "integer" format: "int32" @@ -15602,6 +15602,13 @@ definitions: type: "array" items: $ref: "#/definitions/AuditLog" + HostedPaymentPageFields: + type: "object" + properties: + formFields: + type: "array" + items: + $ref: "#/definitions/PluginProperty" ComboHostedPaymentPage: type: "object" properties: @@ -15619,13 +15626,6 @@ definitions: type: "array" items: $ref: "#/definitions/AuditLog" - HostedPaymentPageFields: - type: "object" - properties: - formFields: - type: "array" - items: - $ref: "#/definitions/PluginProperty" ComboPaymentTransaction: type: "object" properties: @@ -15647,6 +15647,33 @@ definitions: type: "array" items: $ref: "#/definitions/AuditLog" + UserRoles: + type: "object" + required: + - "password" + - "roles" + - "username" + properties: + username: + type: "string" + password: + type: "string" + roles: + type: "array" + items: + type: "string" + RoleDefinition: + type: "object" + required: + - "permissions" + - "role" + properties: + role: + type: "string" + permissions: + type: "array" + items: + type: "string" Session: type: "object" properties: @@ -15674,37 +15701,10 @@ definitions: type: "boolean" session: $ref: "#/definitions/Session" - UserRoles: - type: "object" - required: - - "password" - - "roles" - - "username" - properties: - username: - type: "string" - password: - type: "string" - roles: - type: "array" - items: - type: "string" - RoleDefinition: - type: "object" - required: - - "permissions" - - "role" - properties: - role: - type: "string" - permissions: - type: "array" - items: - type: "string" BulkSubscriptionsBundle: type: "object" required: - - "baseEntitlementAndAddOns" + - "baseEntitlementAndAddOns" properties: baseEntitlementAndAddOns: type: "array" @@ -15713,8 +15713,8 @@ definitions: TagDefinition: type: "object" required: - - "description" - - "name" + - "description" + - "name" properties: id: type: "string" @@ -15731,38 +15731,25 @@ definitions: items: type: "string" enum: - - "ACCOUNT" - - "ACCOUNT_EMAIL" - - "BLOCKING_STATES" - - "BUNDLE" - - "CUSTOM_FIELD" - - "INVOICE" - - "PAYMENT" - - "TRANSACTION" - - "INVOICE_ITEM" - - "INVOICE_PAYMENT" - - "SUBSCRIPTION" - - "SUBSCRIPTION_EVENT" - - "SERVICE_BROADCAST" - - "PAYMENT_ATTEMPT" - - "PAYMENT_METHOD" - - "TAG" - - "TAG_DEFINITION" - - "TENANT" - - "TENANT_KVS" - auditLogs: - type: "array" - items: - $ref: "#/definitions/AuditLog" - TenantKeyValue: - type: "object" - properties: - key: - type: "string" - values: - type: "array" - items: - type: "string" + - "ACCOUNT" + - "ACCOUNT_EMAIL" + - "BLOCKING_STATES" + - "BUNDLE" + - "CUSTOM_FIELD" + - "INVOICE" + - "PAYMENT" + - "TRANSACTION" + - "INVOICE_ITEM" + - "INVOICE_PAYMENT" + - "SUBSCRIPTION" + - "SUBSCRIPTION_EVENT" + - "SERVICE_BROADCAST" + - "PAYMENT_ATTEMPT" + - "PAYMENT_METHOD" + - "TAG" + - "TAG_DEFINITION" + - "TENANT" + - "TENANT_KVS" auditLogs: type: "array" items: @@ -15770,8 +15757,8 @@ definitions: Tenant: type: "object" required: - - "apiKey" - - "apiSecret" + - "apiKey" + - "apiSecret" properties: tenantId: type: "string" @@ -15786,6 +15773,19 @@ definitions: type: "array" items: $ref: "#/definitions/AuditLog" + TenantKeyValue: + type: "object" + properties: + key: + type: "string" + values: + type: "array" + items: + type: "string" + auditLogs: + type: "array" + items: + $ref: "#/definitions/AuditLog" RolledUpUnit: type: "object" properties: @@ -15812,8 +15812,8 @@ definitions: SubscriptionUsageRecord: type: "object" required: - - "subscriptionId" - - "unitUsageRecords" + - "subscriptionId" + - "unitUsageRecords" properties: subscriptionId: type: "string" @@ -15840,4 +15840,4 @@ definitions: type: "string" format: "date-time" amount: - type: "number" + type: "number" \ No newline at end of file From b0e0e62ed192d34150ad1a750fd1cf6cabf2a46b Mon Sep 17 00:00:00 2001 From: xsalefter Date: Sun, 7 Apr 2024 02:12:47 +0700 Subject: [PATCH 4/4] update generated API and classes --- src/api.ts | 8 ++++---- src/base.ts | 2 +- src/common.ts | 2 +- src/configuration.ts | 2 +- src/index.ts | 2 +- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/api.ts b/src/api.ts index 8a8cf0d..388ed3f 100644 --- a/src/api.ts +++ b/src/api.ts @@ -4,7 +4,7 @@ * Kill Bill * Kill Bill is an open-source billing and payments platform * - * The version of the OpenAPI document: 0.24.0 + * The version of the OpenAPI document: 0.24.10 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -1145,19 +1145,19 @@ export interface Entity { * @type {string} * @memberof Entity */ - 'id'?: string; + 'createdDate'?: string; /** * * @type {string} * @memberof Entity */ - 'createdDate'?: string; + 'updatedDate'?: string; /** * * @type {string} * @memberof Entity */ - 'updatedDate'?: string; + 'id'?: string; } /** * diff --git a/src/base.ts b/src/base.ts index a370af5..3d41685 100644 --- a/src/base.ts +++ b/src/base.ts @@ -4,7 +4,7 @@ * Kill Bill * Kill Bill is an open-source billing and payments platform * - * The version of the OpenAPI document: 0.24.0 + * The version of the OpenAPI document: 0.24.10 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/common.ts b/src/common.ts index 751583b..919a005 100644 --- a/src/common.ts +++ b/src/common.ts @@ -4,7 +4,7 @@ * Kill Bill * Kill Bill is an open-source billing and payments platform * - * The version of the OpenAPI document: 0.24.0 + * The version of the OpenAPI document: 0.24.10 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/configuration.ts b/src/configuration.ts index f9b6406..f027aac 100644 --- a/src/configuration.ts +++ b/src/configuration.ts @@ -4,7 +4,7 @@ * Kill Bill * Kill Bill is an open-source billing and payments platform * - * The version of the OpenAPI document: 0.24.0 + * The version of the OpenAPI document: 0.24.10 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/index.ts b/src/index.ts index 467ba66..2e36654 100644 --- a/src/index.ts +++ b/src/index.ts @@ -3,7 +3,7 @@ * Kill Bill * Kill Bill is an open-source billing and payments platform * - * The version of the OpenAPI document: 0.24.0 + * The version of the OpenAPI document: 0.24.10 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).