diff --git a/.swagger-codegen/KB_VERSION b/.swagger-codegen/KB_VERSION index 325720e..0936051 100644 --- a/.swagger-codegen/KB_VERSION +++ b/.swagger-codegen/KB_VERSION @@ -1,4 +1,4 @@ swaggerVersion=2.4.1 -kbVersion=0.24.19-SNAPSHOT +kbVersion=0.24.20-SNAPSHOT kbApiVersion=0.54.0 kbPluginApiVersion=0.27.3 diff --git a/.swagger-codegen/kbswagger.yaml b/.swagger-codegen/kbswagger.yaml index 84939dc..29b08a7 100644 --- a/.swagger-codegen/kbswagger.yaml +++ b/.swagger-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.19-SNAPSHOT" + version: "0.24.20-SNAPSHOT" title: "Kill Bill" contact: name: "killbilling-users@googlegroups.com" @@ -34,76 +34,47 @@ tags: - name: "PaymentTransaction" - name: "Usage" paths: - /1.0/kb/accounts/{accountId}/tags: - get: - tags: - - "Account" - summary: "Retrieve account tags" - description: "" - operationId: "getAccountTags" - produces: - - "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" - responses: - "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/payments: post: tags: - "Account" - summary: "Add tags to account" + summary: "Trigger a payment using the account external key (authorization, purchase\ + \ or credit)" description: "" - operationId: "createAccountTags" + operationId: "processPaymentByExternalKey" consumes: - "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: - type: "array" - items: - type: "string" - format: "uuid" + $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 @@ -118,23 +89,34 @@ paths: type: "string" responses: "201": - description: "Tag created successfully" + description: "Payment transaction created successfully" schema: - type: "array" - items: - $ref: "#/definitions/Tag" + $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: [] - delete: + /1.0/kb/accounts/{accountId}/cbaRebalancing: + put: tags: - "Account" - summary: "Remove tags from account" + summary: "Rebalance account CBA" description: "" - operationId: "deleteAccountTags" + operationId: "rebalanceExistingCBAOnAccount" consumes: - "application/json" produces: @@ -146,14 +128,6 @@ paths: 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 @@ -170,8 +144,7 @@ paths: "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: "Invalid account id supplied" security: - basicAuth: [] - Killbill Api Key: [] @@ -354,6 +327,35 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] + /1.0/kb/accounts/{accountId}/auditLogs: + get: + tags: + - "Account" + summary: "Retrieve audit logs by account id" + description: "" + operationId: "getAccountAuditLogs" + 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" + schema: + type: "array" + items: + $ref: "#/definitions/AuditLog" + "404": + description: "Account not found" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/accounts/{accountId}/block: get: tags: @@ -469,13 +471,42 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/auditLogs: + /1.0/kb/accounts/block/{blockingId}/auditLogsWithHistory: get: tags: - "Account" - summary: "Retrieve audit logs by account id" + summary: "Retrieve blocking state audit logs with history by id" description: "" - operationId: "getAccountAuditLogs" + operationId: "getBlockingStateAuditLogsWithHistory" + produces: + - "application/json" + parameters: + - name: "blockingId" + 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: "Blocking state not found" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/accounts/{accountId}/emails/{accountEmailId}/auditLogsWithHistory: + get: + tags: + - "Account" + summary: "Retrieve account email audit logs with history by id" + description: "" + operationId: "getAccountEmailAuditLogsWithHistory" produces: - "application/json" parameters: @@ -485,6 +516,12 @@ paths: 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: "200": description: "successful operation" @@ -498,26 +535,23 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts: + /1.0/kb/accounts/{accountId}/tags: get: tags: - "Account" - summary: "Retrieve an account by external key" + summary: "Retrieve account tags" description: "" - operationId: "getAccountByKey" + operationId: "getAccountTags" produces: - "application/json" parameters: - - name: "externalKey" - in: "query" + - name: "accountId" + in: "path" required: true type: "string" - - name: "accountWithBalance" - in: "query" - required: false - type: "boolean" - default: false - - name: "accountWithBalanceAndCBA" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "includedDeleted" in: "query" required: false type: "boolean" @@ -535,7 +569,11 @@ paths: "200": description: "successful operation" schema: - $ref: "#/definitions/Account" + type: "array" + items: + $ref: "#/definitions/Tag" + "400": + description: "Invalid account id supplied" "404": description: "Account not found" security: @@ -545,19 +583,28 @@ paths: post: tags: - "Account" - summary: "Create account" + summary: "Add tags to account" description: "" - operationId: "createAccount" + operationId: "createAccountTags" consumes: - "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/Account" + type: "array" + items: + type: "string" + format: "uuid" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -572,79 +619,71 @@ paths: type: "string" responses: "201": - description: "Account created successfully" + description: "Tag created successfully" schema: - $ref: "#/definitions/Account" + type: "array" + items: + $ref: "#/definitions/Tag" "400": - description: "Invalid account data supplied" + description: "Invalid account id supplied" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/search/{searchKey}: - get: + delete: tags: - "Account" - summary: "Search accounts" + summary: "Remove tags from account" description: "" - operationId: "searchAccounts" + operationId: "deleteAccountTags" + consumes: + - "application/json" produces: - "application/json" parameters: - - name: "searchKey" + - name: "accountId" 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" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "tagDef" in: "query" required: false - type: "boolean" - default: false - - name: "accountWithBalanceAndCBA" - in: "query" + 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: "boolean" - default: false - - name: "audit" - in: "query" + type: "string" + - name: "X-Killbill-Comment" + in: "header" required: false type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" responses: - "200": - description: "successful operation" - schema: - type: "array" - items: - $ref: "#/definitions/Account" + "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: + /1.0/kb/accounts/{accountId}/invoicePayments: get: tags: - "Account" - summary: "Retrieve an account emails" + summary: "Retrieve account invoice payments" description: "" - operationId: "getEmails" + operationId: "getInvoicePayments" produces: - "application/json" parameters: @@ -654,15 +693,43 @@ paths: 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: type: "array" items: - $ref: "#/definitions/AccountEmail" + $ref: "#/definitions/InvoicePayment" "400": description: "Invalid account id supplied" + "404": + description: "Account not found" security: - basicAuth: [] - Killbill Api Key: [] @@ -670,9 +737,9 @@ paths: post: tags: - "Account" - summary: "Add account email" + summary: "Trigger a payment for all unpaid invoices" description: "" - operationId: "addEmail" + operationId: "payAllInvoices" consumes: - "application/json" produces: @@ -684,58 +751,32 @@ paths: 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" + - name: "paymentMethodId" + in: "query" required: false type: "string" - responses: - "201": - description: "Email created successfully" - schema: - 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/{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 + - 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 @@ -749,62 +790,16 @@ paths: required: false type: "string" responses: - "204": + "201": description: "Successful operation" - "400": - description: "Invalid account id supplied" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/accounts/pagination: - get: - tags: - - "Account" - summary: "List accounts" - description: "" - operationId: "getAccounts" - 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: "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" + $ref: "#/definitions/Invoice" + "204": + description: "Nothing to pay" + "404": + description: "Invalid account id supplied" security: - basicAuth: [] - Killbill Api Key: [] @@ -961,13 +956,13 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/children: + /1.0/kb/accounts/{accountId}/bundles: get: tags: - "Account" - summary: "List children accounts" + summary: "Retrieve bundles for account" description: "" - operationId: "getChildrenAccounts" + operationId: "getAccountBundles" produces: - "application/json" parameters: @@ -977,16 +972,14 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "accountWithBalance" + - name: "externalKey" in: "query" required: false - type: "boolean" - default: false - - name: "accountWithBalanceAndCBA" + type: "string" + - name: "bundlesFilter" in: "query" required: false - type: "boolean" - default: false + type: "string" - name: "audit" in: "query" required: false @@ -1002,78 +995,37 @@ paths: schema: type: "array" items: - $ref: "#/definitions/Account" + $ref: "#/definitions/Bundle" "400": - description: "Invalid parent account id supplied" + description: "Invalid account id supplied" "404": - description: "Parent Account not found" + description: "Account not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{childAccountId}/transferCredit: - put: + /1.0/kb/accounts/{accountId}/payments: + get: tags: - "Account" - summary: "Move a given child credit to the parent level" + summary: "Retrieve account payments" description: "" - operationId: "transferChildCreditToParent" - consumes: - - "application/json" + operationId: "getPaymentsForAccount" produces: - "application/json" parameters: - - name: "childAccountId" + - 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: - "204": - description: "Successful operation" - "400": - description: "Account does not have credit" - "404": - description: "Account not found" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/invoicePayments: - get: - tags: - - "Account" - summary: "Retrieve account invoice payments" - description: "" - operationId: "getInvoicePayments" - produces: - - "application/json" - parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "withPluginInfo" + - name: "withAttempts" in: "query" required: false type: "boolean" default: false - - name: "withAttempts" + - name: "withPluginInfo" in: "query" required: false type: "boolean" @@ -1100,11 +1052,9 @@ paths: schema: type: "array" items: - $ref: "#/definitions/InvoicePayment" + $ref: "#/definitions/Payment" "400": description: "Invalid account id supplied" - "404": - description: "Account not found" security: - basicAuth: [] - Killbill Api Key: [] @@ -1112,9 +1062,9 @@ paths: post: tags: - "Account" - summary: "Trigger a payment for all unpaid invoices" + summary: "Trigger a payment (authorization, purchase or credit)" description: "" - operationId: "payAllInvoices" + operationId: "processPayment" consumes: - "application/json" produces: @@ -1126,25 +1076,23 @@ paths: 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: "externalPayment" - in: "query" - required: false - type: "boolean" - default: false - - name: "paymentAmount" - in: "query" - required: false - type: "number" - - name: "targetDate" + - name: "controlPluginName" in: "query" required: false - type: "string" - format: "date" + type: "array" + items: + type: "string" + collectionFormat: "multi" - name: "pluginProperty" in: "query" required: false @@ -1166,28 +1114,34 @@ paths: type: "string" responses: "201": - description: "Successful operation" + description: "Payment transaction created successfully" schema: - type: "array" - items: - $ref: "#/definitions/Invoice" - "204": - description: "Nothing to pay" - "404": + $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: [] - /1.0/kb/accounts/{accountId}/paymentMethods/{paymentMethodId}/setDefault: - put: + /1.0/kb/accounts/{accountId}/overdue: + get: tags: - "Account" - summary: "Set the default payment method" + summary: "Retrieve overdue state for account" description: "" - operationId: "setDefaultPaymentMethod" - consumes: - - "application/json" + operationId: "getOverdueAccount" produces: - "application/json" parameters: @@ -1197,54 +1151,26 @@ paths: 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: - 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" + "200": + description: "successful operation" + schema: + $ref: "#/definitions/OverdueState" "400": - description: "Invalid account id or payment method id supplied" + 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: + /1.0/kb/accounts/{accountId}/allCustomFields: + get: tags: - "Account" - summary: "Refresh account payment methods" + summary: "Retrieve account customFields" description: "" - operationId: "refreshPaymentMethods" + operationId: "getAllCustomFields" produces: - "application/json" parameters: @@ -1254,32 +1180,46 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "pluginName" + - name: "objectType" in: "query" required: false type: "string" - - name: "pluginProperty" + 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: "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" + 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 account id supplied" "404": @@ -1288,13 +1228,13 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/paymentMethods: + /1.0/kb/accounts/{accountId}/timeline: get: tags: - "Account" - summary: "Retrieve account payment methods" + summary: "Retrieve account timeline" description: "" - operationId: "getPaymentMethodsForAccount" + operationId: "getAccountTimeline" produces: - "application/json" parameters: @@ -1304,23 +1244,11 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "withPluginInfo" - in: "query" - required: false - type: "boolean" - default: false - - name: "includedDeleted" + - name: "parallel" 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 @@ -1334,9 +1262,7 @@ paths: "200": description: "successful operation" schema: - type: "array" - items: - $ref: "#/definitions/PaymentMethod" + $ref: "#/definitions/AccountTimeline" "400": description: "Invalid account id supplied" "404": @@ -1345,14 +1271,13 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - post: + /1.0/kb/accounts/{accountId}/allTags: + get: tags: - "Account" - summary: "Add a payment method" + summary: "Retrieve account tags" description: "" - operationId: "createPaymentMethod" - consumes: - - "application/json" + operationId: "getAllTags" produces: - "application/json" parameters: @@ -1362,52 +1287,51 @@ paths: 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" + - name: "objectType" 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" + 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: "string" - - name: "X-Killbill-Comment" - in: "header" + type: "boolean" + default: false + - name: "audit" + in: "query" required: false type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: - "201": - description: "Payment method created" + "200": + description: "successful operation" schema: - $ref: "#/definitions/PaymentMethod" + type: "array" + items: + $ref: "#/definitions/Tag" "400": description: "Invalid account id supplied" "404": @@ -1416,13 +1340,13 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/auditLogsWithHistory: + /1.0/kb/accounts/{accountId}/emails: get: tags: - "Account" - summary: "Retrieve account audit logs with history by account id" + summary: "Retrieve an account emails" description: "" - operationId: "getAccountAuditLogsWithHistory" + operationId: "getEmails" produces: - "application/json" parameters: @@ -1438,20 +1362,21 @@ paths: schema: type: "array" items: - $ref: "#/definitions/AuditLog" - "404": - description: "Account not found" + $ref: "#/definitions/AccountEmail" + "400": + description: "Invalid account id supplied" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/bundles: - get: + post: tags: - "Account" - summary: "Retrieve bundles for account" + summary: "Add account email" description: "" - operationId: "getAccountBundles" + operationId: "addEmail" + consumes: + - "application/json" produces: - "application/json" parameters: @@ -1461,30 +1386,30 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "externalKey" - in: "query" - required: false + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/AccountEmail" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true type: "string" - - name: "bundlesFilter" - in: "query" + - name: "X-Killbill-Reason" + in: "header" required: false type: "string" - - name: "audit" - in: "query" + - name: "X-Killbill-Comment" + in: "header" required: false type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" responses: - "200": - description: "successful operation" + "201": + description: "Email created successfully" schema: type: "array" items: - $ref: "#/definitions/Bundle" + $ref: "#/definitions/AccountEmail" "400": description: "Invalid account id supplied" "404": @@ -1493,34 +1418,30 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/bundles/pagination: + /1.0/kb/accounts: get: tags: - "Account" - summary: "Retrieve paginated bundles for account" + summary: "Retrieve an account by external key" description: "" - operationId: "getAccountBundlesPaginated" + operationId: "getAccountByKey" produces: - "application/json" parameters: - - name: "accountId" - in: "path" + - name: "externalKey" + in: "query" required: true type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "offset" + - name: "accountWithBalance" in: "query" required: false - type: "integer" - default: 0 - format: "int64" - - name: "limit" + type: "boolean" + default: false + - name: "accountWithBalanceAndCBA" in: "query" required: false - type: "integer" - default: 100 - format: "int64" + type: "boolean" + default: false - name: "audit" in: "query" required: false @@ -1534,69 +1455,80 @@ paths: "200": description: "successful operation" schema: - type: "array" - items: - $ref: "#/definitions/Bundle" - "400": - description: "Invalid account id supplied" + $ref: "#/definitions/Account" "404": description: "Account not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/emails/{accountEmailId}/auditLogsWithHistory: - get: + post: tags: - "Account" - summary: "Retrieve account email audit logs with history by id" + summary: "Create account" description: "" - operationId: "getAccountEmailAuditLogsWithHistory" + operationId: "createAccount" + consumes: + - "application/json" produces: - "application/json" parameters: - - name: "accountId" - in: "path" + - in: "body" + name: "body" required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "accountEmailId" - in: "path" + schema: + $ref: "#/definitions/Account" + - name: "X-Killbill-CreatedBy" + in: "header" required: true type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" + - 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: "Account created successfully" schema: - type: "array" - items: - $ref: "#/definitions/AuditLog" - "404": - description: "Account not found" + $ref: "#/definitions/Account" + "400": + description: "Invalid account data supplied" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/timeline: + /1.0/kb/accounts/pagination: get: tags: - "Account" - summary: "Retrieve account timeline" + summary: "List accounts" description: "" - operationId: "getAccountTimeline" + operationId: "getAccounts" produces: - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "parallel" + - 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" @@ -1614,60 +1546,55 @@ paths: "200": description: "successful operation" schema: - $ref: "#/definitions/AccountTimeline" - "400": - description: "Invalid account id supplied" - "404": - description: "Account not found" + type: "array" + items: + $ref: "#/definitions/Account" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/allCustomFields: + /1.0/kb/accounts/search/{searchKey}: get: tags: - "Account" - summary: "Retrieve account customFields" + summary: "Search accounts" description: "" - operationId: "getAllCustomFields" + operationId: "searchAccounts" produces: - "application/json" parameters: - - name: "accountId" + - name: "searchKey" in: "path" required: true type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "objectType" + 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" - 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" + default: "NONE" enum: - "FULL" - "MINIMAL" @@ -1678,22 +1605,18 @@ paths: schema: type: "array" items: - $ref: "#/definitions/CustomField" - "400": - description: "Invalid account id supplied" - "404": - description: "Account not found" + $ref: "#/definitions/Account" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/allTags: - get: + /1.0/kb/accounts/{accountId}/emails/{email}: + delete: tags: - "Account" - summary: "Retrieve account tags" + summary: "Delete email from account" description: "" - operationId: "getAllTags" + operationId: "removeEmail" produces: - "application/json" parameters: @@ -1703,70 +1626,42 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "objectType" - in: "query" - required: false + - name: "email" + in: "path" + required: true 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" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" required: false - type: "boolean" - default: false - - name: "audit" - in: "query" + type: "string" + - name: "X-Killbill-Comment" + in: "header" required: false type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" 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/accounts/block/{blockingId}/auditLogsWithHistory: + /1.0/kb/accounts/{accountId}/auditLogsWithHistory: get: tags: - "Account" - summary: "Retrieve blocking state audit logs with history by id" + summary: "Retrieve account audit logs with history by account id" description: "" - operationId: "getBlockingStateAuditLogsWithHistory" + operationId: "getAccountAuditLogsWithHistory" produces: - "application/json" parameters: - - name: "blockingId" + - name: "accountId" in: "path" required: true type: "string" @@ -1780,7 +1675,7 @@ paths: items: $ref: "#/definitions/AuditLog" "404": - description: "Blocking state not found" + description: "Account not found" security: - basicAuth: [] - Killbill Api Key: [] @@ -1911,42 +1806,13 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/overdue: - get: - tags: - - "Account" - summary: "Retrieve overdue state for account" - description: "" - operationId: "getOverdueAccount" - 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" - schema: - $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/{accountId}/payments: + /1.0/kb/accounts/{accountId}/paymentMethods: get: tags: - "Account" - summary: "Retrieve account payments" + summary: "Retrieve account payment methods" description: "" - operationId: "getPaymentsForAccount" + operationId: "getPaymentMethodsForAccount" produces: - "application/json" parameters: @@ -1956,12 +1822,12 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "withAttempts" + - name: "withPluginInfo" in: "query" required: false type: "boolean" default: false - - name: "withPluginInfo" + - name: "includedDeleted" in: "query" required: false type: "boolean" @@ -1988,9 +1854,11 @@ paths: schema: type: "array" items: - $ref: "#/definitions/Payment" + $ref: "#/definitions/PaymentMethod" "400": description: "Invalid account id supplied" + "404": + description: "Account not found" security: - basicAuth: [] - Killbill Api Key: [] @@ -1998,9 +1866,9 @@ paths: post: tags: - "Account" - summary: "Trigger a payment (authorization, purchase or credit)" + summary: "Add a payment method" description: "" - operationId: "processPayment" + operationId: "createPaymentMethod" consumes: - "application/json" produces: @@ -2016,12 +1884,17 @@ paths: name: "body" required: true schema: - $ref: "#/definitions/PaymentTransaction" - - name: "paymentMethodId" + $ref: "#/definitions/PaymentMethod" + - name: "isDefault" in: "query" required: false - type: "string" - format: "uuid" + type: "boolean" + default: false + - name: "payAllUnpaidInvoices" + in: "query" + required: false + type: "boolean" + default: false - name: "controlPluginName" in: "query" required: false @@ -2050,110 +1923,76 @@ paths: type: "string" responses: "201": - description: "Payment transaction created successfully" + description: "Payment method created" schema: - $ref: "#/definitions/Payment" + $ref: "#/definitions/PaymentMethod" "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: [] - /1.0/kb/accounts/payments: - post: + /1.0/kb/accounts/{accountId}/bundles/pagination: + get: tags: - "Account" - summary: "Trigger a payment using the account external key (authorization, purchase\ - \ or credit)" + summary: "Retrieve paginated bundles for account" description: "" - operationId: "processPaymentByExternalKey" - consumes: - - "application/json" + operationId: "getAccountBundlesPaginated" produces: - "application/json" parameters: - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/PaymentTransaction" - - name: "externalKey" - in: "query" + - name: "accountId" + in: "path" required: true type: "string" - - name: "paymentMethodId" - in: "query" - required: false - type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "controlPluginName" + - name: "offset" in: "query" required: false - type: "array" - items: - type: "string" - collectionFormat: "multi" - - name: "pluginProperty" + type: "integer" + default: 0 + format: "int64" + - name: "limit" 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" + type: "integer" + default: 100 + format: "int64" + - name: "audit" + in: "query" required: false type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: - "201": - description: "Payment transaction created successfully" + "200": + description: "successful operation" schema: - $ref: "#/definitions/Payment" + type: "array" + items: + $ref: "#/definitions/Bundle" "400": - description: "Invalid account external key supplied" + 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: [] - /1.0/kb/accounts/{accountId}/cbaRebalancing: + /1.0/kb/accounts/{accountId}/paymentMethods/{paymentMethodId}/setDefault: put: tags: - "Account" - summary: "Rebalance account CBA" + summary: "Set the default payment method" description: "" - operationId: "rebalanceExistingCBAOnAccount" + operationId: "setDefaultPaymentMethod" consumes: - "application/json" produces: @@ -2165,6 +2004,24 @@ paths: 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: + type: "string" + collectionFormat: "multi" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -2181,73 +2038,185 @@ paths: "204": description: "Successful operation" "400": - description: "Invalid account id supplied" + 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/admin/healthcheck: + /1.0/kb/accounts/{accountId}/paymentMethods/refresh: put: tags: - - "Admin" - summary: "Put the host back into rotation" + - "Account" + summary: "Refresh account payment methods" description: "" - operationId: "putInRotation" + operationId: "refreshPaymentMethods" produces: - "application/json" - parameters: [] + 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: + 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 supplied" + "404": + description: "Account not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - delete: + /1.0/kb/accounts/{accountId}/children: + get: tags: - - "Admin" - summary: "Put the host out of rotation" + - "Account" + summary: "List children accounts" description: "" - operationId: "putOutOfRotation" + operationId: "getChildrenAccounts" produces: - "application/json" - parameters: [] + 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: - "204": - description: "Successful operation" + "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/admin/payments/{paymentId}/transactions/{paymentTransactionId}: + /1.0/kb/accounts/{childAccountId}/transferCredit: put: tags: - - "Admin" - summary: "Update existing paymentTransaction and associated payment state" + - "Account" + summary: "Move a given child credit to the parent level" description: "" - operationId: "updatePaymentTransactionState" + operationId: "transferChildCreditToParent" consumes: - "application/json" produces: - "application/json" parameters: - - name: "paymentId" + - name: "childAccountId" in: "path" required: true type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "paymentTransactionId" - in: "path" + - name: "X-Killbill-CreatedBy" + in: "header" 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-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" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/admin/invoices: + post: + tags: + - "Admin" + summary: "Trigger an invoice generation for all parked accounts" + description: "" + 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 @@ -2260,11 +2229,42 @@ paths: in: "header" required: false type: "string" + responses: + "200": + description: "Successful operation" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/admin/healthcheck: + put: + tags: + - "Admin" + summary: "Put the host back into rotation" + description: "" + operationId: "putInRotation" + produces: + - "application/json" + parameters: [] + responses: + "204": + description: "Successful operation" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + delete: + tags: + - "Admin" + summary: "Put the host out of rotation" + description: "" + operationId: "putOutOfRotation" + produces: + - "application/json" + parameters: [] responses: "204": description: "Successful operation" - "400": - description: "Invalid account data supplied" security: - basicAuth: [] - Killbill Api Key: [] @@ -2397,40 +2397,38 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/admin/invoices: - post: + /1.0/kb/admin/payments/{paymentId}/transactions/{paymentTransactionId}: + put: tags: - "Admin" - summary: "Trigger an invoice generation for all parked accounts" + summary: "Update existing paymentTransaction and associated payment state" description: "" - operationId: "triggerInvoiceGenerationForParkedAccounts" + operationId: "updatePaymentTransactionState" 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 + - 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" @@ -2441,19 +2439,21 @@ paths: required: false type: "string" responses: - "200": + "204": description: "Successful operation" + "400": + description: "Invalid account data supplied" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/bundles/{bundleId}: + /1.0/kb/bundles/{bundleId}/customFields: get: tags: - "Bundle" - summary: "Retrieve a bundle by id" + summary: "Retrieve bundle custom fields" description: "" - operationId: "getBundle" + operationId: "getBundleCustomFields" produces: - "application/json" parameters: @@ -2476,11 +2476,11 @@ paths: "200": description: "successful operation" schema: - $ref: "#/definitions/Bundle" + type: "array" + items: + $ref: "#/definitions/CustomField" "400": description: "Invalid bundle id supplied" - "404": - description: "Bundle not found" security: - basicAuth: [] - Killbill Api Key: [] @@ -2488,9 +2488,9 @@ paths: post: tags: - "Bundle" - summary: "Transfer a bundle to another account" + summary: "Add custom fields to bundle" description: "" - operationId: "transferBundle" + operationId: "createBundleCustomFields" consumes: - "application/json" produces: @@ -2506,38 +2506,9 @@ paths: 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" + type: "array" + items: + $ref: "#/definitions/CustomField" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -2552,68 +2523,23 @@ paths: type: "string" responses: "201": - description: "Bundle transferred successfully" - schema: - $ref: "#/definitions/Bundle" - "400": - description: "Invalid bundle id, requested date or policy supplied" - "404": - description: "Bundle not found" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/bundles/{bundleId}/tags: - get: - tags: - - "Bundle" - summary: "Retrieve bundle tags" - description: "" - operationId: "getBundleTags" - produces: - - "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" - responses: - "200": - description: "successful operation" + description: "Custom field created successfully" schema: type: "array" items: - $ref: "#/definitions/Tag" + $ref: "#/definitions/CustomField" "400": description: "Invalid bundle id supplied" - "404": - description: "Bundle not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - post: + put: tags: - "Bundle" - summary: "Add tags to bundle" + summary: "Modify custom fields to bundle" description: "" - operationId: "createBundleTags" + operationId: "modifyBundleCustomFields" consumes: - "application/json" produces: @@ -2631,8 +2557,7 @@ paths: schema: type: "array" items: - type: "string" - format: "uuid" + $ref: "#/definitions/CustomField" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -2646,12 +2571,8 @@ paths: required: false type: "string" responses: - "201": - description: "Tag created successfully" - schema: - type: "array" - items: - $ref: "#/definitions/Tag" + "204": + description: "Successful operation" "400": description: "Invalid bundle id supplied" security: @@ -2661,9 +2582,9 @@ paths: delete: tags: - "Bundle" - summary: "Remove tags from bundle" + summary: "Remove custom fields from bundle" description: "" - operationId: "deleteBundleTags" + operationId: "deleteBundleCustomFields" consumes: - "application/json" produces: @@ -2675,7 +2596,7 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "tagDef" + - name: "customField" in: "query" required: false type: "array" @@ -2704,13 +2625,13 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/bundles/{bundleId}/customFields: + /1.0/kb/bundles/{bundleId}/tags: get: tags: - "Bundle" - summary: "Retrieve bundle custom fields" + summary: "Retrieve bundle tags" description: "" - operationId: "getBundleCustomFields" + operationId: "getBundleTags" produces: - "application/json" parameters: @@ -2720,6 +2641,11 @@ paths: 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 @@ -2735,9 +2661,11 @@ paths: schema: type: "array" items: - $ref: "#/definitions/CustomField" + $ref: "#/definitions/Tag" "400": description: "Invalid bundle id supplied" + "404": + description: "Bundle not found" security: - basicAuth: [] - Killbill Api Key: [] @@ -2745,9 +2673,9 @@ paths: post: tags: - "Bundle" - summary: "Add custom fields to bundle" + summary: "Add tags to bundle" description: "" - operationId: "createBundleCustomFields" + operationId: "createBundleTags" consumes: - "application/json" produces: @@ -2765,7 +2693,8 @@ paths: schema: type: "array" items: - $ref: "#/definitions/CustomField" + type: "string" + format: "uuid" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -2780,23 +2709,23 @@ paths: 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 bundle id supplied" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - put: + delete: tags: - "Bundle" - summary: "Modify custom fields to bundle" + summary: "Remove tags from bundle" description: "" - operationId: "modifyBundleCustomFields" + operationId: "deleteBundleTags" consumes: - "application/json" produces: @@ -2808,13 +2737,14 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - in: "body" - name: "body" - required: true - schema: - type: "array" - items: - $ref: "#/definitions/CustomField" + - name: "tagDef" + in: "query" + required: false + type: "array" + items: + type: "string" + format: "uuid" + collectionFormat: "multi" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -2836,16 +2766,15 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - delete: + /1.0/kb/bundles/{bundleId}/renameKey: + put: tags: - "Bundle" - summary: "Remove custom fields from bundle" + summary: "Update a bundle externalKey" description: "" - operationId: "deleteBundleCustomFields" + operationId: "renameExternalKey" consumes: - "application/json" - produces: - - "application/json" parameters: - name: "bundleId" in: "path" @@ -2853,14 +2782,11 @@ paths: 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" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/Bundle" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -2877,7 +2803,9 @@ paths: "204": description: "Successful operation" "400": - description: "Invalid bundle id supplied" + description: "Invalid argumnent supplied" + "404": + description: "Bundle not found" security: - basicAuth: [] - Killbill Api Key: [] @@ -2923,28 +2851,22 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/bundles/pagination: + /1.0/kb/bundles/{bundleId}: get: tags: - "Bundle" - summary: "List bundles" + summary: "Retrieve a bundle by id" description: "" - operationId: "getBundles" + operationId: "getBundle" 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: "bundleId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" - name: "audit" in: "query" required: false @@ -2958,20 +2880,21 @@ paths: "200": description: "successful operation" schema: - type: "array" - items: - $ref: "#/definitions/Bundle" + $ref: "#/definitions/Bundle" + "400": + description: "Invalid bundle id supplied" + "404": + description: "Bundle not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/bundles/{bundleId}/pause: - put: + post: tags: - "Bundle" - summary: "Pause a bundle" + summary: "Transfer a bundle to another account" description: "" - operationId: "pauseBundle" + operationId: "transferBundle" consumes: - "application/json" produces: @@ -2983,11 +2906,35 @@ paths: 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 @@ -3008,67 +2955,67 @@ paths: required: false type: "string" responses: - "204": - description: "Successful operation" + "201": + description: "Bundle transferred successfully" + schema: + $ref: "#/definitions/Bundle" "400": - description: "Invalid bundle id supplied" + description: "Invalid bundle id, requested date or policy supplied" "404": description: "Bundle not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/bundles/{bundleId}/renameKey: - put: + /1.0/kb/bundles/pagination: + get: tags: - "Bundle" - summary: "Update a bundle externalKey" + summary: "List bundles" description: "" - operationId: "renameExternalKey" - consumes: + operationId: "getBundles" + 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" + - name: "offset" + in: "query" required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" + 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: - "204": - description: "Successful operation" - "400": - description: "Invalid argumnent supplied" - "404": - description: "Bundle not found" + "200": + description: "successful operation" + schema: + type: "array" + items: + $ref: "#/definitions/Bundle" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/bundles/{bundleId}/resume: + /1.0/kb/bundles/{bundleId}/pause: put: tags: - "Bundle" - summary: "Resume a bundle" + summary: "Pause a bundle" description: "" - operationId: "resumeBundle" + operationId: "pauseBundle" consumes: - "application/json" produces: @@ -3162,15 +3109,17 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/bundles/{bundleId}/block: - post: + /1.0/kb/bundles/{bundleId}/resume: + put: tags: - "Bundle" - summary: "Block a bundle" + summary: "Resume a bundle" description: "" - operationId: "addBundleBlockingState" + operationId: "resumeBundle" consumes: - "application/json" + produces: + - "application/json" parameters: - name: "bundleId" in: "path" @@ -3178,11 +3127,6 @@ paths: 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 @@ -3208,12 +3152,8 @@ paths: 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 bundle id supplied" "404": @@ -3251,23 +3191,39 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/catalog/simplePlan: + /1.0/kb/bundles/{bundleId}/block: post: tags: - - "Catalog" - summary: "Add a simple plan entry in the current version of the catalog" + - "Bundle" + summary: "Block a bundle" description: "" - operationId: "addSimplePlan" + operationId: "addBundleBlockingState" 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: - $ref: "#/definitions/SimplePlan" + $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 @@ -3282,28 +3238,29 @@ paths: type: "string" responses: "201": - description: "Created new plan successfully" + description: "Blocking state created successfully" schema: - type: "string" + type: "array" + items: + $ref: "#/definitions/BlockingState" + "400": + description: "Invalid bundle id supplied" + "404": + description: "Bundle not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/catalog: + /1.0/kb/catalog/availableBasePlans: get: tags: - "Catalog" - summary: "Retrieve the catalog as JSON" + summary: "Retrieve available base plans" description: "" - operationId: "getCatalogJson" + operationId: "getAvailableBasePlans" produces: - "application/json" parameters: - - name: "requestedDate" - in: "query" - required: false - type: "string" - format: "date-time" - name: "accountId" in: "query" required: false @@ -3315,167 +3272,144 @@ paths: schema: type: "array" items: - $ref: "#/definitions/Catalog" + $ref: "#/definitions/PlanDetail" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - delete: + /1.0/kb/catalog/priceList: + get: tags: - "Catalog" - summary: "Delete all versions for a per tenant catalog" + summary: "Retrieve priceList for a given subscription and date" description: "" - operationId: "deleteCatalog" + operationId: "getPriceListForSubscriptionAndDate" + produces: + - "application/json" parameters: - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" + - name: "subscriptionId" + in: "query" required: false type: "string" - - name: "X-Killbill-Comment" - in: "header" + format: "uuid" + - name: "requestedDate" + in: "query" required: false type: "string" + format: "date" responses: - "204": - description: "Successful operation" + "200": + description: "successful operation" + schema: + $ref: "#/definitions/PriceList" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/catalog/availableAddons: + /1.0/kb/catalog/product: get: tags: - "Catalog" - summary: "Retrieve available add-ons for a given product" + summary: "Retrieve product for a given subscription and date" description: "" - operationId: "getAvailableAddons" + operationId: "getProductForSubscriptionAndDate" produces: - "application/json" parameters: - - name: "baseProductName" - in: "query" - required: false - type: "string" - - name: "priceListName" + - name: "subscriptionId" in: "query" required: false type: "string" - - name: "accountId" + format: "uuid" + - name: "requestedDate" in: "query" required: false type: "string" - format: "uuid" + 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/availableBasePlans: + /1.0/kb/catalog/plan: get: tags: - "Catalog" - summary: "Retrieve available base plans" + summary: "Retrieve plan for a given subscription and date" description: "" - operationId: "getAvailableBasePlans" + operationId: "getPlanForSubscriptionAndDate" produces: - "application/json" parameters: - - name: "accountId" + - 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/Plan" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/catalog/versions: + /1.0/kb/catalog/phase: get: tags: - "Catalog" - summary: "Retrieve a list of catalog versions" + summary: "Retrieve phase for a given subscription and date" description: "" - operationId: "getCatalogVersions" + operationId: "getPhaseForSubscriptionAndDate" produces: - "application/json" parameters: - - name: "accountId" + - name: "subscriptionId" in: "query" required: false type: "string" format: "uuid" - responses: - "200": - description: "successful operation" - schema: - type: "array" - items: - type: "string" - format: "date-time" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/catalog/xml: - get: - tags: - - "Catalog" - summary: "Retrieve the full catalog as XML" - description: "" - operationId: "getCatalogXml" - produces: - - "text/xml" - parameters: - name: "requestedDate" in: "query" required: false type: "string" - format: "date-time" - - name: "accountId" - in: "query" - required: false - type: "string" - format: "uuid" + format: "date" responses: "200": description: "successful operation" schema: - type: "string" + $ref: "#/definitions/Phase" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] + /1.0/kb/catalog/simplePlan: post: tags: - "Catalog" - summary: "Upload the full catalog as XML" + summary: "Add a simple plan entry in the current version of the catalog" description: "" - operationId: "uploadCatalogXml" + operationId: "addSimplePlan" consumes: - - "text/xml" + - "application/json" + produces: + - "application/json" parameters: - in: "body" name: "body" required: true schema: - type: "string" + $ref: "#/definitions/SimplePlan" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -3490,125 +3424,130 @@ paths: type: "string" responses: "201": - description: "Catalog XML created successfully" + description: "Created new plan successfully" schema: type: "string" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/catalog/phase: + /1.0/kb/catalog: get: tags: - "Catalog" - summary: "Retrieve phase for a given subscription and date" + summary: "Retrieve the catalog as JSON" description: "" - operationId: "getPhaseForSubscriptionAndDate" + operationId: "getCatalogJson" produces: - "application/json" parameters: - - name: "subscriptionId" + - name: "requestedDate" in: "query" required: false type: "string" - format: "uuid" - - name: "requestedDate" + format: "date-time" + - name: "accountId" in: "query" required: false type: "string" - format: "date" + format: "uuid" responses: "200": description: "successful operation" schema: - $ref: "#/definitions/Phase" + type: "array" + items: + $ref: "#/definitions/Catalog" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/catalog/plan: - get: + delete: tags: - "Catalog" - summary: "Retrieve plan for a given subscription and date" + summary: "Delete all versions for a per tenant catalog" description: "" - operationId: "getPlanForSubscriptionAndDate" - produces: - - "application/json" + operationId: "deleteCatalog" parameters: - - name: "subscriptionId" - in: "query" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" required: false type: "string" - format: "uuid" - - name: "requestedDate" - in: "query" + - name: "X-Killbill-Comment" + in: "header" required: false type: "string" - format: "date" responses: - "200": - description: "successful operation" - schema: - $ref: "#/definitions/Plan" + "204": + description: "Successful operation" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/catalog/priceList: + /1.0/kb/catalog/xml: get: tags: - "Catalog" - summary: "Retrieve priceList for a given subscription and date" + summary: "Retrieve the full catalog as XML" description: "" - operationId: "getPriceListForSubscriptionAndDate" + operationId: "getCatalogXml" produces: - - "application/json" + - "text/xml" parameters: - - name: "subscriptionId" + - name: "requestedDate" in: "query" required: false type: "string" - format: "uuid" - - name: "requestedDate" + format: "date-time" + - name: "accountId" in: "query" required: false type: "string" - format: "date" + format: "uuid" responses: "200": description: "successful operation" schema: - $ref: "#/definitions/PriceList" + type: "string" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/catalog/product: - get: + post: tags: - "Catalog" - summary: "Retrieve product for a given subscription and date" + summary: "Upload the full catalog as XML" description: "" - operationId: "getProductForSubscriptionAndDate" - produces: - - "application/json" + operationId: "uploadCatalogXml" + consumes: + - "text/xml" parameters: - - name: "subscriptionId" - in: "query" + - 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" - format: "uuid" - - name: "requestedDate" - in: "query" + - name: "X-Killbill-Comment" + in: "header" required: false type: "string" - format: "date" responses: - "200": - description: "successful operation" + "201": + description: "Catalog XML created successfully" schema: - $ref: "#/definitions/Product" + type: "string" security: - basicAuth: [] - Killbill Api Key: [] @@ -3651,6 +3590,96 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] + /1.0/kb/catalog/availableAddons: + get: + tags: + - "Catalog" + summary: "Retrieve available add-ons for a given product" + description: "" + operationId: "getAvailableAddons" + produces: + - "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" + responses: + "200": + description: "successful operation" + schema: + type: "array" + items: + $ref: "#/definitions/PlanDetail" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/catalog/versions: + get: + tags: + - "Catalog" + summary: "Retrieve a list of catalog versions" + description: "" + operationId: "getCatalogVersions" + produces: + - "application/json" + parameters: + - name: "accountId" + in: "query" + required: false + type: "string" + format: "uuid" + responses: + "200": + description: "successful operation" + schema: + type: "array" + items: + type: "string" + format: "date-time" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/credits/{creditId}: + get: + tags: + - "Credit" + summary: "Retrieve a credit by id" + description: "" + operationId: "getCredit" + produces: + - "application/json" + parameters: + - name: "creditId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + responses: + "200": + description: "successful operation" + schema: + $ref: "#/definitions/InvoiceItem" + "400": + description: "Invalid credit id supplied" + "404": + description: "Credit not found" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/credits: post: tags: @@ -3714,42 +3743,13 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/credits/{creditId}: + /1.0/kb/customFields/pagination: get: tags: - - "Credit" - summary: "Retrieve a credit by id" + - "CustomField" + summary: "List custom fields" description: "" - operationId: "getCredit" - produces: - - "application/json" - parameters: - - name: "creditId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - responses: - "200": - description: "successful operation" - schema: - $ref: "#/definitions/InvoiceItem" - "400": - description: "Invalid credit id supplied" - "404": - description: "Credit not found" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/customFields/pagination: - get: - tags: - - "CustomField" - summary: "List custom fields" - description: "" - operationId: "getCustomFields" + operationId: "getCustomFields" produces: - "application/json" parameters: @@ -3832,35 +3832,6 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/customFields/{customFieldId}/auditLogsWithHistory: - get: - tags: - - "CustomField" - summary: "Retrieve custom field audit logs with history by id" - description: "" - operationId: "getCustomFieldAuditLogsWithHistory" - produces: - - "application/json" - parameters: - - 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/AuditLog" - "404": - description: "Account not found" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] /1.0/kb/customFields/search: get: tags: @@ -3915,6 +3886,35 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] + /1.0/kb/customFields/{customFieldId}/auditLogsWithHistory: + get: + tags: + - "CustomField" + summary: "Retrieve custom field audit logs with history by id" + description: "" + operationId: "getCustomFieldAuditLogsWithHistory" + produces: + - "application/json" + parameters: + - 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/AuditLog" + "404": + description: "Account not found" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/export/{accountId}: get: tags: @@ -3954,13 +3954,13 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoiceItems/{invoiceItemId}/tags: + /1.0/kb/invoiceItems/{invoiceItemId}/customFields: get: tags: - "InvoiceItem" - summary: "Retrieve invoice item tags" + summary: "Retrieve invoice item custom fields" description: "" - operationId: "getInvoiceItemTags" + operationId: "getInvoiceItemCustomFields" produces: - "application/json" parameters: @@ -3970,16 +3970,6 @@ paths: 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 @@ -3995,11 +3985,9 @@ paths: 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: [] @@ -4007,9 +3995,9 @@ paths: post: tags: - "InvoiceItem" - summary: "Add tags to invoice item" + summary: "Add custom fields to invoice item" description: "" - operationId: "createInvoiceItemTags" + operationId: "createInvoiceItemCustomFields" consumes: - "application/json" produces: @@ -4027,8 +4015,7 @@ paths: schema: type: "array" items: - type: "string" - format: "uuid" + $ref: "#/definitions/CustomField" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -4043,23 +4030,23 @@ paths: type: "string" responses: "201": - description: "Tag created successfully" + description: "Custom field created successfully" schema: type: "array" items: - $ref: "#/definitions/Tag" + $ref: "#/definitions/CustomField" "400": description: "Invalid invoice item id supplied" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - delete: + put: tags: - "InvoiceItem" - summary: "Remove tags from invoice item" + summary: "Modify custom fields to invoice item" description: "" - operationId: "deleteInvoiceItemTags" + operationId: "modifyInvoiceItemCustomFields" consumes: - "application/json" produces: @@ -4071,14 +4058,13 @@ paths: 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" + - in: "body" + name: "body" + required: true + schema: + type: "array" + items: + $ref: "#/definitions/CustomField" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -4100,13 +4086,14 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoiceItems/{invoiceItemId}/customFields: - get: + delete: tags: - "InvoiceItem" - summary: "Retrieve invoice item custom fields" + summary: "Remove custom fields from invoice item" description: "" - operationId: "getInvoiceItemCustomFields" + operationId: "deleteInvoiceItemCustomFields" + consumes: + - "application/json" produces: - "application/json" parameters: @@ -4116,36 +4103,42 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "audit" + - 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" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" responses: - "200": - description: "successful operation" - schema: - type: "array" - items: - $ref: "#/definitions/CustomField" + "204": + description: "Successful operation" "400": description: "Invalid invoice item id supplied" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - post: + /1.0/kb/invoiceItems/{invoiceItemId}/tags: + get: tags: - "InvoiceItem" - summary: "Add custom fields to invoice item" + summary: "Retrieve invoice item tags" description: "" - operationId: "createInvoiceItemCustomFields" - consumes: - - "application/json" + operationId: "getInvoiceItemTags" produces: - "application/json" parameters: @@ -4155,44 +4148,46 @@ paths: 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" + - name: "accountId" + in: "query" required: true type: "string" - - name: "X-Killbill-Reason" - in: "header" + format: "uuid" + - name: "includedDeleted" + in: "query" required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" + 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" + $ref: "#/definitions/Tag" "400": description: "Invalid invoice item id supplied" + "404": + description: "Account not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - put: + post: tags: - "InvoiceItem" - summary: "Modify custom fields to invoice item" + summary: "Add tags to invoice item" description: "" - operationId: "modifyInvoiceItemCustomFields" + operationId: "createInvoiceItemTags" consumes: - "application/json" produces: @@ -4210,7 +4205,8 @@ paths: schema: type: "array" items: - $ref: "#/definitions/CustomField" + type: "string" + format: "uuid" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -4224,8 +4220,12 @@ paths: required: false type: "string" responses: - "204": - description: "Successful operation" + "201": + description: "Tag created successfully" + schema: + type: "array" + items: + $ref: "#/definitions/Tag" "400": description: "Invalid invoice item id supplied" security: @@ -4235,9 +4235,9 @@ paths: delete: tags: - "InvoiceItem" - summary: "Remove custom fields from invoice item" + summary: "Remove tags from invoice item" description: "" - operationId: "deleteInvoiceItemCustomFields" + operationId: "deleteInvoiceItemTags" consumes: - "application/json" produces: @@ -4249,7 +4249,7 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "customField" + - name: "tagDef" in: "query" required: false type: "array" @@ -4307,13 +4307,13 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoicePayments/{paymentId}/tags: + /1.0/kb/invoicePayments/{paymentId}/customFields: get: tags: - "InvoicePayment" - summary: "Retrieve payment tags" + summary: "Retrieve payment custom fields" description: "" - operationId: "getInvoicePaymentTags" + operationId: "getInvoicePaymentCustomFields" produces: - "application/json" parameters: @@ -4323,18 +4323,6 @@ paths: 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 @@ -4350,11 +4338,9 @@ paths: schema: type: "array" items: - $ref: "#/definitions/Tag" + $ref: "#/definitions/CustomField" "400": description: "Invalid payment id supplied" - "404": - description: "Payment not found" security: - basicAuth: [] - Killbill Api Key: [] @@ -4362,9 +4348,9 @@ paths: post: tags: - "InvoicePayment" - summary: "Add tags to payment" + summary: "Add custom fields to payment" description: "" - operationId: "createInvoicePaymentTags" + operationId: "createInvoicePaymentCustomFields" consumes: - "application/json" produces: @@ -4382,8 +4368,7 @@ paths: schema: type: "array" items: - type: "string" - format: "uuid" + $ref: "#/definitions/CustomField" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -4398,11 +4383,56 @@ paths: type: "string" responses: "201": - description: "Tag created successfully" + description: "Custom field created successfully" schema: type: "array" items: - $ref: "#/definitions/Tag" + $ref: "#/definitions/CustomField" + "400": + description: "Invalid payment id supplied" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + put: + tags: + - "InvoicePayment" + summary: "Modify custom fields to payment" + description: "" + operationId: "modifyInvoicePaymentCustomFields" + 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: + $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: @@ -4412,9 +4442,9 @@ paths: delete: tags: - "InvoicePayment" - summary: "Remove tags from payment" + summary: "Remove custom fields from payment" description: "" - operationId: "deleteInvoicePaymentTags" + operationId: "deleteInvoicePaymentCustomFields" consumes: - "application/json" produces: @@ -4426,7 +4456,7 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "tagDef" + - name: "customField" in: "query" required: false type: "array" @@ -4455,13 +4485,42 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoicePayments/{paymentId}/customFields: + /1.0/kb/invoicePayments/{invoicePaymentId}/auditLogsWithHistory: get: tags: - "InvoicePayment" - summary: "Retrieve payment custom fields" + summary: "Retrieve invoice payment audit logs with history by id" description: "" - operationId: "getInvoicePaymentCustomFields" + operationId: "getInvoicePaymentAuditLogsWithHistory" + produces: + - "application/json" + parameters: + - name: "invoicePaymentId" + 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 payment not found" + 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: @@ -4471,6 +4530,18 @@ paths: 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 @@ -4486,9 +4557,11 @@ paths: schema: type: "array" items: - $ref: "#/definitions/CustomField" + $ref: "#/definitions/Tag" "400": description: "Invalid payment id supplied" + "404": + description: "Payment not found" security: - basicAuth: [] - Killbill Api Key: [] @@ -4496,9 +4569,9 @@ paths: post: tags: - "InvoicePayment" - summary: "Add custom fields to payment" + summary: "Add tags to payment" description: "" - operationId: "createInvoicePaymentCustomFields" + operationId: "createInvoicePaymentTags" consumes: - "application/json" produces: @@ -4516,7 +4589,8 @@ paths: schema: type: "array" items: - $ref: "#/definitions/CustomField" + type: "string" + format: "uuid" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -4531,23 +4605,23 @@ paths: 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 payment id supplied" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - put: + delete: tags: - "InvoicePayment" - summary: "Modify custom fields to payment" + summary: "Remove tags from payment" description: "" - operationId: "modifyInvoicePaymentCustomFields" + operationId: "deleteInvoicePaymentTags" consumes: - "application/json" produces: @@ -4559,13 +4633,14 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - in: "body" - name: "body" - required: true - schema: - type: "array" - items: - $ref: "#/definitions/CustomField" + - name: "tagDef" + in: "query" + required: false + type: "array" + items: + type: "string" + format: "uuid" + collectionFormat: "multi" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -4587,12 +4662,13 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - delete: + /1.0/kb/invoicePayments/{paymentId}/chargebacks: + post: tags: - "InvoicePayment" - summary: "Remove custom fields from payment" + summary: "Record a chargeback" description: "" - operationId: "deleteInvoicePaymentCustomFields" + operationId: "createChargeback" consumes: - "application/json" produces: @@ -4604,13 +4680,17 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "customField" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/InvoicePaymentTransaction" + - name: "pluginProperty" in: "query" required: false type: "array" items: type: "string" - format: "uuid" collectionFormat: "multi" - name: "X-Killbill-CreatedBy" in: "header" @@ -4625,10 +4705,14 @@ paths: required: false type: "string" responses: - "204": - description: "Successful operation" + "201": + description: "Created chargeback successfully" + schema: + $ref: "#/definitions/InvoicePayment" "400": description: "Invalid payment id supplied" + "404": + description: "Account or payment not found" security: - basicAuth: [] - Killbill Api Key: [] @@ -4757,61 +4841,6 @@ paths: - 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: - 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" - schema: - $ref: "#/definitions/InvoicePayment" - "400": - description: "Invalid payment id supplied" - "404": - description: "Account or payment not found" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] /1.0/kb/invoicePayments/{paymentId}/chargebackReversals: post: tags: @@ -4932,42 +4961,52 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoicePayments/{invoicePaymentId}/auditLogsWithHistory: + /1.0/kb/invoices/{invoiceId}/customFields: get: tags: - - "InvoicePayment" - summary: "Retrieve invoice payment audit logs with history by id" + - "Invoice" + summary: "Retrieve invoice custom fields" description: "" - operationId: "getInvoicePaymentAuditLogsWithHistory" + operationId: "getInvoiceCustomFields" produces: - "application/json" parameters: - - name: "invoicePaymentId" + - 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/AuditLog" - "404": - description: "Invoice payment not found" + $ref: "#/definitions/CustomField" + "400": + description: "Invalid invoice id supplied" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoices/{invoiceId}/tags: - get: + post: tags: - "Invoice" - summary: "Retrieve invoice tags" + summary: "Add custom fields to invoice" description: "" - operationId: "getInvoiceTags" + operationId: "createInvoiceCustomFields" + consumes: + - "application/json" produces: - "application/json" parameters: @@ -4977,41 +5016,44 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "includedDeleted" - in: "query" - required: false - type: "boolean" - default: false - - name: "audit" - in: "query" + - 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" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" 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 id supplied" - "404": - description: "Invoice not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - post: + put: tags: - "Invoice" - summary: "Add tags to invoice" + summary: "Modify custom fields to invoice" description: "" - operationId: "createInvoiceTags" + operationId: "modifyInvoiceCustomFields" consumes: - "application/json" produces: @@ -5029,8 +5071,7 @@ paths: schema: type: "array" items: - type: "string" - format: "uuid" + $ref: "#/definitions/CustomField" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -5044,12 +5085,8 @@ paths: required: false type: "string" responses: - "201": - description: "Tag created successfully" - schema: - type: "array" - items: - $ref: "#/definitions/Tag" + "204": + description: "Successful operation" "400": description: "Invalid invoice id supplied" security: @@ -5059,9 +5096,9 @@ paths: delete: tags: - "Invoice" - summary: "Remove tags from invoice" + summary: "Remove custom fields from invoice" description: "" - operationId: "deleteInvoiceTags" + operationId: "deleteInvoiceCustomFields" consumes: - "application/json" produces: @@ -5073,7 +5110,7 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "tagDef" + - name: "customField" in: "query" required: false type: "array" @@ -5102,13 +5139,15 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoices/{invoiceId}/customFields: - get: + /1.0/kb/invoices/{invoiceId}/commitInvoice: + put: tags: - "Invoice" - summary: "Retrieve invoice custom fields" + summary: "Perform the invoice status transition from DRAFT to COMMITTED" description: "" - operationId: "getInvoiceCustomFields" + operationId: "commitInvoice" + consumes: + - "application/json" produces: - "application/json" parameters: @@ -5118,34 +5157,34 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "audit" - in: "query" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" required: false type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" responses: - "200": - description: "successful operation" - schema: - type: "array" - items: - $ref: "#/definitions/CustomField" - "400": - description: "Invalid invoice id supplied" + "204": + description: "Successful operation" + "404": + description: "Invoice not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - post: + /1.0/kb/invoices/{invoiceId}/voidInvoice: + put: tags: - "Invoice" - summary: "Add custom fields to invoice" + summary: "Perform the action of voiding an invoice" description: "" - operationId: "createInvoiceCustomFields" + operationId: "voidInvoice" consumes: - "application/json" produces: @@ -5157,13 +5196,6 @@ paths: 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 @@ -5177,24 +5209,67 @@ paths: required: false type: "string" responses: - "201": - description: "Custom field created successfully" + "204": + description: "Successful operation" + "400": + description: "Invalid invoice id supplied" + "404": + description: "Invoice not found" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoices/{invoiceId}/tags: + get: + tags: + - "Invoice" + summary: "Retrieve invoice tags" + description: "" + operationId: "getInvoiceTags" + produces: + - "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" + responses: + "200": + description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/CustomField" + $ref: "#/definitions/Tag" "400": description: "Invalid invoice id supplied" + "404": + description: "Invoice not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - put: + post: tags: - "Invoice" - summary: "Modify custom fields to invoice" + summary: "Add tags to invoice" description: "" - operationId: "modifyInvoiceCustomFields" + operationId: "createInvoiceTags" consumes: - "application/json" produces: @@ -5212,7 +5287,8 @@ paths: schema: type: "array" items: - $ref: "#/definitions/CustomField" + type: "string" + format: "uuid" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -5226,8 +5302,12 @@ paths: required: false type: "string" responses: - "204": - description: "Successful operation" + "201": + description: "Tag created successfully" + schema: + type: "array" + items: + $ref: "#/definitions/Tag" "400": description: "Invalid invoice id supplied" security: @@ -5237,9 +5317,9 @@ paths: delete: tags: - "Invoice" - summary: "Remove custom fields from invoice" + summary: "Remove tags from invoice" description: "" - operationId: "deleteInvoiceCustomFields" + operationId: "deleteInvoiceTags" consumes: - "application/json" produces: @@ -5251,7 +5331,7 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "customField" + - name: "tagDef" in: "query" required: false type: "array" @@ -5280,24 +5360,48 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoices/{invoiceId}/commitInvoice: - put: + /1.0/kb/invoices/taxes/{accountId}: + post: tags: - "Invoice" - summary: "Perform the invoice status transition from DRAFT to COMMITTED" + summary: "Create tax items" description: "" - operationId: "commitInvoice" + operationId: "createTaxItems" consumes: - "application/json" produces: - "application/json" parameters: - - name: "invoiceId" + - 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: + type: "string" + collectionFormat: "multi" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -5311,23 +5415,27 @@ paths: required: false type: "string" responses: - "204": - description: "Successful operation" + "201": + description: "Create tax items successfully" + schema: + type: "array" + items: + $ref: "#/definitions/InvoiceItem" + "400": + description: "Invalid account id supplied" "404": - description: "Invoice not found" + description: "Account not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoices/{invoiceId}/voidInvoice: - put: + /1.0/kb/invoices/{invoiceId}: + get: tags: - "Invoice" - summary: "Perform the action of voiding an invoice" + summary: "Retrieve an invoice by id" description: "" - operationId: "voidInvoice" - consumes: - - "application/json" + operationId: "getInvoice" produces: - "application/json" parameters: @@ -5337,53 +5445,13 @@ paths: 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" + - name: "withChildrenItems" + in: "query" 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" - "404": - description: "Invoice not found" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoices/pagination: - get: - tags: - - "Invoice" - summary: "List invoices" - description: "" - operationId: "getInvoices" - 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" + type: "boolean" + default: false + - name: "audit" + in: "query" required: false type: "string" default: "NONE" @@ -5395,99 +5463,96 @@ paths: "200": description: "successful operation" schema: - type: "array" - items: - $ref: "#/definitions/Invoice" + $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/search/{searchKey}: - get: + post: tags: - "Invoice" - summary: "Search invoices" + summary: "Adjust an invoice item" description: "" - operationId: "searchInvoices" + operationId: "adjustInvoiceItem" + consumes: + - "application/json" produces: - "application/json" parameters: - - name: "searchKey" + - name: "invoiceId" in: "path" required: true type: "string" - pattern: ".*" - - name: "offset" + 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: "integer" - default: 0 - format: "int64" - - name: "limit" + type: "string" + format: "date" + - name: "pluginProperty" in: "query" required: false - type: "integer" - default: 100 - format: "int64" - - name: "audit" - in: "query" + 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" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" responses: - "200": - description: "successful operation" + "201": + description: "Created adjustment Successfully" schema: - type: "array" - items: - $ref: "#/definitions/Invoice" + $ref: "#/definitions/Invoice" + "400": + 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/{invoiceId}: + /1.0/kb/invoices/template: get: tags: - "Invoice" - summary: "Retrieve an invoice by id" + summary: "Retrieves the invoice template for the tenant" description: "" - operationId: "getInvoice" + operationId: "getInvoiceTemplate" produces: - - "application/json" + - "text/html" parameters: - - name: "invoiceId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "withChildrenItems" + - name: "templateWithBrandInfo" 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" + type: "string" "404": - description: "Invoice not found" + description: "Template not found" security: - basicAuth: [] - Killbill Api Key: [] @@ -5495,37 +5560,29 @@ paths: post: tags: - "Invoice" - summary: "Adjust an invoice item" + summary: "Upload the invoice template for the tenant" description: "" - operationId: "adjustInvoiceItem" + operationId: "uploadInvoiceTemplate" consumes: - - "application/json" + - "text/html" produces: - - "application/json" + - "text/html" 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" + type: "string" + - name: "deleteIfExists" in: "query" required: false - type: "string" - format: "date" - - name: "pluginProperty" + type: "boolean" + default: false + - name: "templateWithBrandInfo" in: "query" required: false - type: "array" - items: - type: "string" - collectionFormat: "multi" + type: "boolean" + default: false - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -5540,33 +5597,29 @@ paths: type: "string" responses: "201": - description: "Created adjustment Successfully" + description: "Uploaded invoice template Successfully" schema: - $ref: "#/definitions/Invoice" - "400": - description: "Invalid account id, invoice id or invoice item id supplied" - "404": - description: "Invoice not found" + type: "string" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoices/byNumber/{invoiceNumber}: + /1.0/kb/invoices/byItemId/{itemId}: get: tags: - "Invoice" - summary: "Retrieve an invoice by number" + summary: "Retrieve an invoice by invoice item id" description: "" - operationId: "getInvoiceByNumber" + operationId: "getInvoiceByItemId" produces: - "application/json" parameters: - - name: "invoiceNumber" + - name: "itemId" in: "path" required: true - type: "integer" - pattern: "[0-9]+" - format: "int32" + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" - name: "withChildrenItems" in: "query" required: false @@ -5592,25 +5645,17 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoices/{invoiceId}/{invoiceItemId}/cba: - delete: + /1.0/kb/invoices/{groupId}/group: + get: tags: - "Invoice" - summary: "Delete a CBA item" + summary: "Retrieve a set of invoices by group id" description: "" - operationId: "deleteCBA" - consumes: - - "application/json" + operationId: "getInvoicesGroup" produces: - "application/json" parameters: - - name: "invoiceId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "invoiceItemId" + - name: "groupId" in: "path" required: true type: "string" @@ -5621,25 +5666,29 @@ paths: required: true type: "string" format: "uuid" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" + - name: "withChildrenItems" + in: "query" required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" + 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/Invoice" "400": - description: "Invalid account id, invoice id or invoice item id supplied" - "404": - description: "Account or invoice not found" + description: "Invalid group id supplied" security: - basicAuth: [] - Killbill Api Key: [] @@ -5671,157 +5720,165 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoices/migration/{accountId}: - post: + /1.0/kb/invoices/pagination: + get: tags: - "Invoice" - summary: "Create a migration invoice" + summary: "List invoices" description: "" - operationId: "createMigrationInvoice" - consumes: - - "application/json" + operationId: "getInvoices" 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: - type: "array" - items: - $ref: "#/definitions/InvoiceItem" - - name: "targetDate" + - name: "offset" in: "query" required: false - type: "string" - format: "date" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" + type: "integer" + default: 0 + format: "int64" + - name: "limit" + in: "query" required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" + type: "integer" + default: 100 + format: "int64" + - name: "audit" + in: "query" required: false type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: - "201": - description: "Created migration invoice successfully" + "200": + description: "successful operation" schema: - $ref: "#/definitions/Invoice" - "400": - description: "Invalid account id or target datetime supplied" + type: "array" + items: + $ref: "#/definitions/Invoice" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoices/charges/{accountId}: - post: + /1.0/kb/invoices/search/{searchKey}: + get: tags: - "Invoice" - summary: "Create external charge(s)" + summary: "Search invoices" description: "" - operationId: "createExternalCharges" - consumes: - - "application/json" + operationId: "searchInvoices" produces: - "application/json" parameters: - - name: "accountId" + - name: "searchKey" 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" + pattern: ".*" + - name: "offset" in: "query" required: false - type: "string" - format: "date" - - name: "autoCommit" + type: "integer" + default: 0 + format: "int64" + - name: "limit" in: "query" required: false - type: "boolean" - default: false - - name: "pluginProperty" + type: "integer" + default: 100 + format: "int64" + - name: "audit" 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" + 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/byNumber/{invoiceNumber}: + get: + tags: + - "Invoice" + summary: "Retrieve an invoice by number" + description: "" + operationId: "getInvoiceByNumber" + produces: + - "application/json" + parameters: + - name: "invoiceNumber" + in: "path" + required: true + type: "integer" + pattern: "[0-9]+" + format: "int32" + - name: "withChildrenItems" + in: "query" required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" + type: "boolean" + default: false + - name: "audit" + in: "query" required: false type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: - "201": - description: "Created external charge Successfully" + "200": + description: "successful operation" schema: - type: "array" - items: - $ref: "#/definitions/InvoiceItem" - "400": - description: "Invalid account id supplied" + $ref: "#/definitions/Invoice" "404": - description: "Account not found" + description: "Invoice not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoices: - post: + /1.0/kb/invoices/{invoiceId}/{invoiceItemId}/cba: + delete: tags: - "Invoice" - summary: "Trigger an invoice generation" + summary: "Delete a CBA item" description: "" - operationId: "createFutureInvoice" + operationId: "deleteCBA" consumes: - "application/json" produces: - "application/json" parameters: - - name: "accountId" - in: "query" + - 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: "targetDate" + - name: "accountId" in: "query" - required: false + required: true type: "string" - format: "date" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: - type: "string" - collectionFormat: "multi" + format: "uuid" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -5835,45 +5892,70 @@ paths: required: false type: "string" responses: - "201": - description: "Created invoice successfully" + "204": + description: "Successful operation" + "400": + 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/catalogTranslation/{locale}: + get: + tags: + - "Invoice" + summary: "Retrieves the catalog translation for the tenant" + description: "" + operationId: "getCatalogTranslation" + produces: + - "text/plain" + parameters: + - name: "locale" + in: "path" + required: true + type: "string" + pattern: ".*" + responses: + "200": + description: "successful operation" schema: - $ref: "#/definitions/Invoice" + type: "string" "400": - description: "Invalid account id or target datetime supplied" + description: "Invalid locale supplied" + "404": + description: "Template not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoices/group: post: tags: - "Invoice" - summary: "Trigger an invoice generation" + summary: "Upload the catalog translation for the tenant" description: "" - operationId: "createFutureInvoiceGroup" + operationId: "uploadCatalogTranslation" consumes: - - "application/json" + - "text/plain" produces: - - "application/json" + - "text/plain" parameters: - - name: "accountId" - in: "query" + - name: "locale" + in: "path" required: true type: "string" - format: "uuid" - - name: "targetDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "pluginProperty" + pattern: ".*" + - in: "body" + name: "body" + required: true + schema: + type: "string" + - name: "deleteIfExists" in: "query" required: false - type: "array" - items: - type: "string" - collectionFormat: "multi" + type: "boolean" + default: false - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -5888,13 +5970,9 @@ paths: type: "string" responses: "201": - description: "Created invoice successfully" + description: "Uploaded catalog translation Successfully" schema: - type: "array" - items: - $ref: "#/definitions/Invoice" - "400": - description: "Invalid account id or target datetime supplied" + type: "string" security: - basicAuth: [] - Killbill Api Key: [] @@ -6017,37 +6095,24 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoices/taxes/{accountId}: + /1.0/kb/invoices: post: tags: - "Invoice" - summary: "Create tax items" + summary: "Trigger an invoice generation" description: "" - operationId: "createTaxItems" + operationId: "createFutureInvoice" consumes: - "application/json" produces: - "application/json" parameters: - name: "accountId" - in: "path" + in: "query" 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" + - name: "targetDate" in: "query" required: false type: "string" @@ -6073,36 +6138,27 @@ paths: type: "string" responses: "201": - description: "Create tax items successfully" + description: "Created invoice successfully" schema: - type: "array" - items: - $ref: "#/definitions/InvoiceItem" + $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/dryRun: + /1.0/kb/invoices/group: post: tags: - "Invoice" - summary: "Generate a dryRun invoice" + summary: "Trigger an invoice generation" description: "" - operationId: "generateDryRunInvoice" + operationId: "createFutureInvoiceGroup" consumes: - "application/json" produces: - "application/json" parameters: - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/InvoiceDryRun" - name: "accountId" in: "query" required: true @@ -6133,25 +6189,25 @@ paths: required: false type: "string" responses: - "200": - description: "successful operation" + "201": + description: "Created invoice successfully" schema: - $ref: "#/definitions/Invoice" - "204": - description: "Nothing to generate" + 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/catalogTranslation/{locale}: + /1.0/kb/invoices/translation/{locale}: get: tags: - "Invoice" - summary: "Retrieves the catalog translation for the tenant" + summary: "Retrieves the invoice translation for the tenant" description: "" - operationId: "getCatalogTranslation" + operationId: "getInvoiceTranslation" produces: - "text/plain" parameters: @@ -6168,7 +6224,7 @@ paths: "400": description: "Invalid locale supplied" "404": - description: "Template not found" + description: "Translation not found" security: - basicAuth: [] - Killbill Api Key: [] @@ -6176,9 +6232,9 @@ paths: post: tags: - "Invoice" - summary: "Upload the catalog translation for the tenant" + summary: "Upload the invoice translation for the tenant" description: "" - operationId: "uploadCatalogTranslation" + operationId: "uploadInvoiceTranslation" consumes: - "text/plain" produces: @@ -6213,79 +6269,78 @@ paths: type: "string" responses: "201": - description: "Uploaded catalog translation Successfully" + description: "Uploaded invoice translation Successfully" schema: type: "string" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoices/{invoiceId}/auditLogsWithHistory: - get: + /1.0/kb/invoices/charges/{accountId}: + post: tags: - "Invoice" - summary: "Retrieve invoice audit logs with history by id" + summary: "Create external charge(s)" description: "" - operationId: "getInvoiceAuditLogsWithHistory" + operationId: "createExternalCharges" + consumes: + - "application/json" produces: - "application/json" parameters: - - name: "invoiceId" + - 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/AuditLog" - "404": - description: "Invoice not found" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoices/byItemId/{itemId}: - get: - tags: - - "Invoice" - summary: "Retrieve an invoice by invoice item id" - description: "" - operationId: "getInvoiceByItemId" - produces: - - "application/json" - parameters: - - name: "itemId" - in: "path" + - in: "body" + name: "body" required: true + schema: + type: "array" + items: + $ref: "#/definitions/InvoiceItem" + - name: "requestedDate" + in: "query" + required: false type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "withChildrenItems" + format: "date" + - name: "autoCommit" in: "query" required: false type: "boolean" default: false - - name: "audit" + - 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" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" responses: - "200": - description: "successful operation" + "201": + description: "Created external charge Successfully" schema: - $ref: "#/definitions/Invoice" + type: "array" + items: + $ref: "#/definitions/InvoiceItem" + "400": + description: "Invalid account id supplied" "404": - description: "Invoice not found" + description: "Account not found" security: - basicAuth: [] - Killbill Api Key: [] @@ -6316,33 +6371,42 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoices/template: + /1.0/kb/invoices/{invoiceId}/auditLogsWithHistory: get: tags: - "Invoice" - summary: "Retrieves the invoice template for the tenant" + summary: "Retrieve invoice audit logs with history by id" description: "" - operationId: "getInvoiceTemplate" + operationId: "getInvoiceAuditLogsWithHistory" produces: - - "text/html" - parameters: [] + - "application/json" + parameters: + - name: "invoiceId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" responses: "200": description: "successful operation" schema: - type: "string" + type: "array" + items: + $ref: "#/definitions/AuditLog" "404": - description: "Template not found" + description: "Invoice not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] + /1.0/kb/invoices/manualPayTemplate: post: tags: - "Invoice" - summary: "Upload the invoice template for the tenant" + summary: "Upload the manualPay invoice template for the tenant" description: "" - operationId: "uploadInvoiceTemplate" + operationId: "uploadInvoiceMPTemplate" consumes: - "text/html" produces: @@ -6370,69 +6434,49 @@ paths: in: "header" required: false type: "string" - responses: - "201": - description: "Uploaded invoice template Successfully" - schema: - type: "string" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoices/translation/{locale}: - get: - tags: - - "Invoice" - summary: "Retrieves the invoice translation for the tenant" - description: "" - operationId: "getInvoiceTranslation" - produces: - - "text/plain" - parameters: - - name: "locale" - in: "path" - required: true - type: "string" - pattern: ".*" responses: "200": description: "successful operation" schema: type: "string" - "400": - description: "Invalid locale supplied" - "404": - description: "Translation not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] + /1.0/kb/invoices/dryRun: post: tags: - "Invoice" - summary: "Upload the invoice translation for the tenant" + summary: "Generate a dryRun invoice" description: "" - operationId: "uploadInvoiceTranslation" + operationId: "generateDryRunInvoice" 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: - type: "string" - - name: "deleteIfExists" + $ref: "#/definitions/InvoiceDryRun" + - name: "accountId" + in: "query" + required: true + type: "string" + format: "uuid" + - name: "targetDate" in: "query" required: false - type: "boolean" - default: 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 @@ -6446,84 +6490,48 @@ paths: required: false type: "string" responses: - "201": - description: "Uploaded invoice translation Successfully" + "200": + description: "successful operation" schema: - type: "string" + $ref: "#/definitions/Invoice" + "204": + description: "Nothing to generate" + "400": + description: "Invalid account id or target datetime supplied" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoices/{groupId}/group: - get: + /1.0/kb/invoices/migration/{accountId}: + post: tags: - "Invoice" - summary: "Retrieve a set of invoices by group id" + summary: "Create a migration invoice" description: "" - operationId: "getInvoicesGroup" + operationId: "createMigrationInvoice" + consumes: + - "application/json" produces: - "application/json" parameters: - - name: "groupId" + - name: "accountId" 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/Invoice" - "400": - description: "Invalid group id supplied" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoices/manualPayTemplate: - post: - tags: - - "Invoice" - summary: "Upload the manualPay invoice template for the tenant" - description: "" - operationId: "uploadInvoiceMPTemplate" - consumes: - - "text/html" - produces: - - "text/html" - parameters: - in: "body" name: "body" required: true schema: - type: "string" - - name: "deleteIfExists" + type: "array" + items: + $ref: "#/definitions/InvoiceItem" + - name: "targetDate" in: "query" required: false - type: "boolean" - default: false + type: "string" + format: "date" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -6537,10 +6545,12 @@ paths: required: false type: "string" responses: - "200": - description: "successful operation" + "201": + description: "Created migration invoice successfully" schema: - type: "string" + $ref: "#/definitions/Invoice" + "400": + description: "Invalid account id or target datetime supplied" security: - basicAuth: [] - Killbill Api Key: [] @@ -6718,34 +6728,23 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/paymentGateways/hosted/form/{accountId}: + /1.0/kb/paymentGateways/hosted/form: post: tags: - "PaymentGateway" - summary: "Generate form data to redirect the customer to the gateway" + summary: "Combo API to generate form data to redirect the customer to the gateway" description: "" - operationId: "buildFormDescriptor" + operationId: "buildComboFormDescriptor" consumes: - "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/HostedPaymentPageFields" - - name: "paymentMethodId" - in: "query" - required: false - type: "string" - format: "uuid" + $ref: "#/definitions/ComboHostedPaymentPage" - name: "controlPluginName" in: "query" required: false @@ -6777,34 +6776,40 @@ paths: description: "successful operation" schema: $ref: "#/definitions/HostedPaymentPageFormDescriptor" - "404": - description: "Account not found" + "400": + description: "Invalid data for Account or PaymentMethod" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/paymentGateways/notification/{pluginName}: + /1.0/kb/paymentGateways/hosted/form/{accountId}: post: tags: - "PaymentGateway" - summary: "Process a gateway notification" - description: "The response is built by the appropriate plugin" - operationId: "processNotification" + summary: "Generate form data to redirect the customer to the gateway" + description: "" + operationId: "buildFormDescriptor" consumes: - - "*/*" + - "application/json" produces: - "application/json" parameters: - - name: "pluginName" + - name: "accountId" in: "path" required: true type: "string" - pattern: ".*" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" - in: "body" name: "body" required: true schema: - type: "string" + $ref: "#/definitions/HostedPaymentPageFields" + - name: "paymentMethodId" + in: "query" + required: false + type: "string" + format: "uuid" - name: "controlPluginName" in: "query" required: false @@ -6833,28 +6838,37 @@ paths: type: "string" responses: "200": - description: "Successful" + description: "successful operation" + schema: + $ref: "#/definitions/HostedPaymentPageFormDescriptor" + "404": + description: "Account not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/paymentGateways/hosted/form: + /1.0/kb/paymentGateways/notification/{pluginName}: post: tags: - "PaymentGateway" - summary: "Combo API to generate form data to redirect the customer to the gateway" - description: "" - operationId: "buildComboFormDescriptor" + summary: "Process a gateway notification" + description: "The response is built by the appropriate plugin" + operationId: "processNotification" consumes: - - "application/json" + - "*/*" produces: - "application/json" parameters: + - name: "pluginName" + in: "path" + required: true + type: "string" + pattern: ".*" - in: "body" name: "body" required: true schema: - $ref: "#/definitions/ComboHostedPaymentPage" + type: "string" - name: "controlPluginName" in: "query" required: false @@ -6883,11 +6897,7 @@ paths: type: "string" responses: "200": - description: "successful operation" - schema: - $ref: "#/definitions/HostedPaymentPageFormDescriptor" - "400": - description: "Invalid data for Account or PaymentMethod" + description: "Successful" security: - basicAuth: [] - Killbill Api Key: [] @@ -7070,79 +7080,45 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/paymentMethods/pagination: + /1.0/kb/paymentMethods/{paymentMethodId}/auditLogsWithHistory: get: tags: - "PaymentMethod" - summary: "List payment methods" + summary: "Retrieve payment method audit logs with history by id" description: "" - operationId: "getPaymentMethods" + operationId: "getPaymentMethodAuditLogsWithHistory" 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: "pluginProperty" - in: "query" - required: false - type: "array" - items: - type: "string" - collectionFormat: "multi" - - name: "audit" - in: "query" - required: false + - name: "paymentMethodId" + in: "path" + required: true 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}: + /1.0/kb/paymentMethods/pagination: get: tags: - "PaymentMethod" - summary: "Search payment methods" + summary: "List payment methods" description: "" - operationId: "searchPaymentMethods" + operationId: "getPaymentMethods" produces: - "application/json" parameters: - - name: "searchKey" - in: "path" - required: true - type: "string" - pattern: ".*" - name: "offset" in: "query" required: false @@ -7301,31 +7277,65 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/paymentMethods/{paymentMethodId}/auditLogsWithHistory: + /1.0/kb/paymentMethods/search/{searchKey}: get: tags: - "PaymentMethod" - summary: "Retrieve payment method audit logs with history by id" + summary: "Search payment methods" description: "" - operationId: "getPaymentMethodAuditLogsWithHistory" + operationId: "searchPaymentMethods" produces: - "application/json" parameters: - - name: "paymentMethodId" + - name: "searchKey" in: "path" required: true type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" + 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" + 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: [] @@ -7381,27 +7391,37 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/payments/{paymentId}/tags: + /1.0/kb/payments: get: tags: - "Payment" - summary: "Retrieve payment payment tags" + summary: "Retrieve a payment by external key" description: "" - operationId: "getPaymentTags" + operationId: "getPaymentByExternalKey" produces: - "application/json" parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "includedDeleted" + - 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 @@ -7415,13 +7435,9 @@ paths: "200": description: "successful operation" schema: - type: "array" - items: - $ref: "#/definitions/Tag" - "400": - description: "Invalid payment id supplied" + $ref: "#/definitions/Payment" "404": - description: "Invoice not found" + description: "Payment not found" security: - basicAuth: [] - Killbill Api Key: [] @@ -7429,28 +7445,33 @@ paths: post: tags: - "Payment" - summary: "Add tags to payment payment" + summary: "Capture an existing authorization" description: "" - operationId: "createPaymentTags" + operationId: "captureAuthorizationByExternalKey" 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" + $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 @@ -7465,41 +7486,115 @@ paths: type: "string" responses: "201": - description: "Tag created successfully" + description: "Payment transaction created successfully" schema: - type: "array" - items: - $ref: "#/definitions/Tag" - "400": - description: "Invalid payment id supplied" + $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" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - delete: + put: tags: - "Payment" - summary: "Remove tags from payment payment" + summary: "Complete an existing transaction" description: "" - operationId: "deletePaymentTags" + operationId: "completeTransactionByExternalKey" consumes: - "application/json" produces: - "application/json" parameters: - - name: "paymentId" - in: "path" + - 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" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "tagDef" + - 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" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + delete: + tags: + - "Payment" + summary: "Void an existing payment" + description: "" + operationId: "voidPaymentByExternalKey" + consumes: + - "application/json" + produces: + - "application/json" + parameters: + - 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" - format: "uuid" collectionFormat: "multi" - name: "X-Killbill-CreatedBy" in: "header" @@ -7516,8 +7611,18 @@ paths: responses: "204": description: "Successful operation" - "400": - description: "Invalid payment id 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: [] @@ -7964,63 +8069,52 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/payments: - get: + /1.0/kb/payments/{paymentTransactionId}/cancelScheduledPaymentTransaction: + delete: tags: - "Payment" - summary: "Retrieve a payment by external key" + summary: "Cancels a scheduled payment attempt retry" description: "" - operationId: "getPaymentByExternalKey" + operationId: "cancelScheduledPaymentTransactionById" + consumes: + - "application/json" produces: - "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" + - name: "paymentTransactionId" + in: "path" required: true type: "string" - - name: "pluginProperty" - in: "query" + 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: "array" - items: - type: "string" - collectionFormat: "multi" - - name: "audit" - in: "query" + type: "string" + - name: "X-Killbill-Comment" + in: "header" required: false type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" responses: - "200": - description: "successful operation" - schema: - $ref: "#/definitions/Payment" - "404": - description: "Payment not found" + "204": + description: "Successful operation" + "400": + description: "Invalid paymentTransactionId supplied" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] + /1.0/kb/payments/chargebackReversals: post: tags: - "Payment" - summary: "Capture an existing authorization" + summary: "Record a chargeback reversal" description: "" - operationId: "captureAuthorizationByExternalKey" + operationId: "chargebackReversalPaymentByExternalKey" consumes: - "application/json" produces: @@ -8078,36 +8172,22 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - put: + /1.0/kb/payments/cancelScheduledPaymentTransaction: + delete: tags: - "Payment" - summary: "Complete an existing transaction" + summary: "Cancels a scheduled payment attempt retry" description: "" - operationId: "completeTransactionByExternalKey" + operationId: "cancelScheduledPaymentTransactionByExternalKey" consumes: - "application/json" produces: - "application/json" parameters: - - 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" + - name: "transactionExternalKey" in: "query" - required: false - type: "array" - items: - type: "string" - collectionFormat: "multi" + required: true + type: "string" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -8123,52 +8203,111 @@ paths: responses: "204": description: "Successful operation" + "400": + description: "Invalid paymentTransactionExternalKey supplied" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/payments/attempts/{paymentAttemptId}/auditLogsWithHistory: + get: + tags: + - "Payment" + summary: "Retrieve payment attempt audit logs with history by id" + description: "" + operationId: "getPaymentAttemptAuditLogsWithHistory" + produces: + - "application/json" + parameters: + - name: "paymentAttemptId" + 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 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: "Account not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - delete: + /1.0/kb/payments/{paymentId}/tags: + get: tags: - "Payment" - summary: "Void an existing payment" + summary: "Retrieve payment payment tags" description: "" - operationId: "voidPaymentByExternalKey" + operationId: "getPaymentTags" + 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: "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: "Invoice not found" + security: + - 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: - $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" + type: "array" + items: + type: "string" + format: "uuid" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -8182,83 +8321,60 @@ paths: 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" + "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: [] - /1.0/kb/payments/pagination: - get: + delete: tags: - "Payment" - summary: "Get payments" + summary: "Remove tags from payment payment" description: "" - operationId: "getPayments" + operationId: "deletePaymentTags" + 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: "pluginName" - in: "query" - required: false + - name: "paymentId" + in: "path" + 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" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "tagDef" in: "query" required: false type: "array" items: type: "string" + format: "uuid" collectionFormat: "multi" - - name: "audit" - in: "query" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" required: false type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" responses: - "200": - description: "successful operation" - schema: - type: "array" - items: - $ref: "#/definitions/Payment" + "204": + description: "Successful operation" + "400": + description: "Invalid payment id supplied" security: - basicAuth: [] - Killbill Api Key: [] @@ -8331,61 +8447,43 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/payments/cancelScheduledPaymentTransaction: - delete: + /1.0/kb/payments/{paymentId}/chargebacks: + post: tags: - "Payment" - summary: "Cancels a scheduled payment attempt retry" + summary: "Record a chargeback" description: "" - operationId: "cancelScheduledPaymentTransactionByExternalKey" + operationId: "chargebackPayment" consumes: - "application/json" produces: - "application/json" parameters: - - name: "transactionExternalKey" - in: "query" + - name: "paymentId" + in: "path" required: true type: "string" - - name: "X-Killbill-CreatedBy" - in: "header" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" + schema: + $ref: "#/definitions/PaymentTransaction" + - name: "controlPluginName" + in: "query" required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "pluginProperty" + in: "query" required: false - type: "string" - responses: - "204": - description: "Successful operation" - "400": - description: "Invalid paymentTransactionExternalKey supplied" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/payments/{paymentTransactionId}/cancelScheduledPaymentTransaction: - delete: - tags: - - "Payment" - summary: "Cancels a scheduled payment attempt retry" - description: "" - operationId: "cancelScheduledPaymentTransactionById" - consumes: - - "application/json" - produces: - - "application/json" - parameters: - - name: "paymentTransactionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" + type: "array" + items: + type: "string" + collectionFormat: "multi" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -8399,21 +8497,35 @@ paths: required: false type: "string" responses: - "204": - description: "Successful operation" + "201": + description: "Payment transaction created successfully" + schema: + $ref: "#/definitions/Payment" "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}/chargebacks: + /1.0/kb/payments/{paymentId}/refunds: post: tags: - "Payment" - summary: "Record a chargeback" + summary: "Refund an existing payment" description: "" - operationId: "chargebackPayment" + operationId: "refundPayment" consumes: - "application/json" produces: @@ -8479,13 +8591,14 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/payments/chargebacks: + /1.0/kb/payments/combo: post: tags: - "Payment" - summary: "Record a chargeback" + summary: "Combo api to create a new payment transaction on a existing (or not)\ + \ account " description: "" - operationId: "chargebackPaymentByExternalKey" + operationId: "createComboPayment" consumes: - "application/json" produces: @@ -8495,7 +8608,7 @@ paths: name: "body" required: true schema: - $ref: "#/definitions/PaymentTransaction" + $ref: "#/definitions/ComboPaymentTransaction" - name: "controlPluginName" in: "query" required: false @@ -8503,13 +8616,6 @@ paths: 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 @@ -8527,8 +8633,8 @@ paths: description: "Payment transaction created successfully" schema: $ref: "#/definitions/Payment" - "404": - description: "Account or payment not found" + "400": + description: "Invalid data for Account or PaymentMethod" "402": description: "Transaction declined by gateway" "422": @@ -8543,24 +8649,81 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/payments/{paymentId}/chargebackReversals: + /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: + 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/refunds: post: tags: - "Payment" - summary: "Record a chargeback reversal" + summary: "Refund an existing payment" description: "" - operationId: "chargebackReversalPayment" + operationId: "refundPaymentByExternalKey" 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 @@ -8597,8 +8760,6 @@ paths: description: "Payment transaction created successfully" schema: $ref: "#/definitions/Payment" - "400": - description: "Invalid paymentId supplied" "404": description: "Account or payment not found" "402": @@ -8615,18 +8776,24 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/payments/chargebackReversals: + /1.0/kb/payments/{paymentId}/chargebackReversals: post: tags: - "Payment" summary: "Record a chargeback reversal" description: "" - operationId: "chargebackReversalPaymentByExternalKey" + operationId: "chargebackReversalPayment" 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 @@ -8663,6 +8830,8 @@ paths: description: "Payment transaction created successfully" schema: $ref: "#/definitions/Payment" + "400": + description: "Invalid paymentId supplied" "404": description: "Account or payment not found" "402": @@ -8679,14 +8848,13 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/payments/combo: + /1.0/kb/payments/chargebacks: post: tags: - "Payment" - summary: "Combo api to create a new payment transaction on a existing (or not)\ - \ account " + summary: "Record a chargeback" description: "" - operationId: "createComboPayment" + operationId: "chargebackPaymentByExternalKey" consumes: - "application/json" produces: @@ -8696,7 +8864,7 @@ paths: name: "body" required: true schema: - $ref: "#/definitions/ComboPaymentTransaction" + $ref: "#/definitions/PaymentTransaction" - name: "controlPluginName" in: "query" required: false @@ -8704,6 +8872,13 @@ paths: 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 @@ -8721,8 +8896,8 @@ paths: description: "Payment transaction created successfully" schema: $ref: "#/definitions/Payment" - "400": - description: "Invalid data for Account or PaymentMethod" + "404": + description: "Account or payment not found" "402": description: "Transaction declined by gateway" "422": @@ -8737,17 +8912,17 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/payments/attempts/{paymentAttemptId}/auditLogsWithHistory: + /1.0/kb/payments/{paymentId}/auditLogsWithHistory: get: tags: - "Payment" - summary: "Retrieve payment attempt audit logs with history by id" + summary: "Retrieve payment audit logs with history by id" description: "" - operationId: "getPaymentAttemptAuditLogsWithHistory" + operationId: "getPaymentAuditLogsWithHistory" produces: - "application/json" parameters: - - name: "paymentAttemptId" + - name: "paymentId" in: "path" required: true type: "string" @@ -8766,218 +8941,51 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/payments/{paymentId}/auditLogsWithHistory: + /1.0/kb/pluginsInfo: get: tags: - - "Payment" - summary: "Retrieve payment audit logs with history by id" + - "PluginInfo" + summary: "Retrieve the list of registered plugins" description: "" - operationId: "getPaymentAuditLogsWithHistory" + operationId: "getPluginsInfo" produces: - "application/json" - parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" + parameters: [] responses: "200": description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/AuditLog" - "404": - description: "Account not found" + $ref: "#/definitions/PluginInfo" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/payments/{paymentId}/refunds: + /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: [] + /1.0/kb/security/users: post: tags: - - "Payment" - summary: "Refund an existing payment" + - "Security" + summary: "Add a new user with roles (to make api requests)" description: "" - operationId: "refundPayment" - 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/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: - "201": - description: "Payment transaction created successfully" - 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" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/payments/refunds: - post: - tags: - - "Payment" - summary: "Refund an existing payment" - description: "" - operationId: "refundPaymentByExternalKey" - consumes: - - "application/json" - produces: - - "application/json" - parameters: - - 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: - "201": - description: "Payment transaction 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" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/pluginsInfo: - get: - tags: - - "PluginInfo" - summary: "Retrieve the list of registered plugins" - description: "" - operationId: "getPluginsInfo" - produces: - - "application/json" - parameters: [] - responses: - "200": - description: "successful operation" - schema: - type: "array" - items: - $ref: "#/definitions/PluginInfo" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/security/permissions: - get: - tags: - - "Security" - summary: "List user permissions" - description: "" - operationId: "getCurrentUserPermissions" - produces: - - "application/json" - parameters: [] - responses: - "200": - description: "successful operation" - schema: - type: "array" - items: - type: "string" - security: - - basicAuth: [] - /1.0/kb/security/users: - post: - tags: - - "Security" - summary: "Add a new user with roles (to make api requests)" - description: "" - operationId: "addUserRoles" + operationId: "addUserRoles" consumes: - "application/json" produces: @@ -9108,23 +9116,23 @@ paths: description: "Successful operation" security: - basicAuth: [] - /1.0/kb/security/users/{username}: - delete: + /1.0/kb/security/roles: + post: tags: - "Security" - summary: "Invalidate an existing user" + summary: "Add a new role definition)" description: "" - operationId: "invalidateUser" + operationId: "addRoleDefinition" consumes: - "application/json" produces: - "application/json" parameters: - - name: "username" - in: "path" + - in: "body" + name: "body" required: true - type: "string" - pattern: ".*" + schema: + $ref: "#/definitions/RoleDefinition" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -9138,17 +9146,18 @@ paths: required: false type: "string" responses: - "204": - description: "Successful operation" + "201": + description: "Role definition created successfully" + schema: + $ref: "#/definitions/RoleDefinition" security: - basicAuth: [] - /1.0/kb/security/roles: - post: + put: tags: - "Security" - summary: "Add a new role definition)" + summary: "Update a new role definition)" description: "" - operationId: "addRoleDefinition" + operationId: "updateRoleDefinition" consumes: - "application/json" produces: @@ -9172,28 +9181,27 @@ paths: required: false type: "string" responses: - "201": - description: "Role definition created successfully" - schema: - $ref: "#/definitions/RoleDefinition" + "204": + description: "Successful operation" security: - basicAuth: [] - put: + /1.0/kb/security/users/{username}: + delete: tags: - "Security" - summary: "Update a new role definition)" + summary: "Invalidate an existing user" description: "" - operationId: "updateRoleDefinition" + operationId: "invalidateUser" consumes: - "application/json" produces: - "application/json" parameters: - - in: "body" - name: "body" + - name: "username" + in: "path" required: true - schema: - $ref: "#/definitions/RoleDefinition" + type: "string" + pattern: ".*" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -9233,13 +9241,13 @@ paths: $ref: "#/definitions/RoleDefinition" security: - basicAuth: [] - /1.0/kb/security/subject: + /1.0/kb/security/permissions: get: tags: - "Security" - summary: "Get user information" + summary: "List user permissions" description: "" - operationId: "getCurrentUserSubject" + operationId: "getCurrentUserPermissions" produces: - "application/json" parameters: [] @@ -9247,16 +9255,18 @@ paths: "200": description: "successful operation" schema: - $ref: "#/definitions/Subject" + type: "array" + items: + type: "string" security: - basicAuth: [] - /1.0/kb/subscriptions/{subscriptionId}/tags: + /1.0/kb/subscriptions/{subscriptionId}/customFields: get: tags: - "Subscription" - summary: "Retrieve subscription tags" + summary: "Retrieve subscription custom fields" description: "" - operationId: "getSubscriptionTags" + operationId: "getSubscriptionCustomFields" produces: - "application/json" parameters: @@ -9266,11 +9276,6 @@ paths: 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 @@ -9286,11 +9291,9 @@ paths: schema: type: "array" items: - $ref: "#/definitions/Tag" + $ref: "#/definitions/CustomField" "400": description: "Invalid subscription id supplied" - "404": - description: "Subscription not found" security: - basicAuth: [] - Killbill Api Key: [] @@ -9298,7 +9301,9 @@ paths: post: tags: - "Subscription" - operationId: "createSubscriptionTags" + summary: "Add custom fields to subscription" + description: "" + operationId: "createSubscriptionCustomFields" consumes: - "application/json" produces: @@ -9316,8 +9321,7 @@ paths: schema: type: "array" items: - type: "string" - format: "uuid" + $ref: "#/definitions/CustomField" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -9332,19 +9336,19 @@ paths: type: "string" responses: "201": - description: "Tag created successfully" + description: "Custom field created successfully" "400": description: "Invalid subscription id supplied" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - delete: + put: tags: - "Subscription" - summary: "Remove tags from subscription" + summary: "Modify custom fields to subscription" description: "" - operationId: "deleteSubscriptionTags" + operationId: "modifySubscriptionCustomFields" consumes: - "application/json" produces: @@ -9356,7 +9360,52 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "tagDef" + - 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: [] + delete: + tags: + - "Subscription" + summary: "Remove custom fields from subscription" + description: "" + operationId: "deleteSubscriptionCustomFields" + consumes: + - "application/json" + produces: + - "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" @@ -9385,13 +9434,13 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/subscriptions/{subscriptionId}/customFields: + /1.0/kb/subscriptions/{subscriptionId}/auditLogsWithHistory: get: tags: - "Subscription" - summary: "Retrieve subscription custom fields" + summary: "Retrieve subscription audit logs with history by id" description: "" - operationId: "getSubscriptionCustomFields" + operationId: "getSubscriptionAuditLogsWithHistory" produces: - "application/json" parameters: @@ -9401,79 +9450,97 @@ paths: 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/CustomField" - "400": - description: "Invalid subscription id supplied" + $ref: "#/definitions/AuditLog" + "404": + description: "Subscription not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - post: + /1.0/kb/subscriptions/events/{eventId}/auditLogsWithHistory: + get: tags: - "Subscription" - summary: "Add custom fields to subscription" + summary: "Retrieve subscription event audit logs with history by id" description: "" - operationId: "createSubscriptionCustomFields" - consumes: - - "application/json" + operationId: "getSubscriptionEventAuditLogsWithHistory" produces: - "application/json" parameters: - - name: "subscriptionId" + - name: "eventId" 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" + 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}/tags: + get: + tags: + - "Subscription" + summary: "Retrieve subscription tags" + description: "" + operationId: "getSubscriptionTags" + produces: + - "application/json" + parameters: + - name: "subscriptionId" + in: "path" required: true type: "string" - - name: "X-Killbill-Reason" - in: "header" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "includedDeleted" + in: "query" required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" + 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/Tag" "400": description: "Invalid subscription id supplied" + "404": + description: "Subscription not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - put: + post: tags: - "Subscription" - summary: "Modify custom fields to subscription" - description: "" - operationId: "modifySubscriptionCustomFields" + operationId: "createSubscriptionTags" consumes: - "application/json" produces: @@ -9491,7 +9558,8 @@ paths: schema: type: "array" items: - $ref: "#/definitions/CustomField" + type: "string" + format: "uuid" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -9505,8 +9573,8 @@ paths: required: false type: "string" responses: - "204": - description: "Successful operation" + "201": + description: "Tag created successfully" "400": description: "Invalid subscription id supplied" security: @@ -9516,9 +9584,9 @@ paths: delete: tags: - "Subscription" - summary: "Remove custom fields from subscription" + summary: "Remove tags from subscription" description: "" - operationId: "deleteSubscriptionCustomFields" + operationId: "deleteSubscriptionTags" consumes: - "application/json" produces: @@ -9530,7 +9598,7 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "customField" + - name: "tagDef" in: "query" required: false type: "array" @@ -9559,32 +9627,92 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/subscriptions/{subscriptionId}/block: - post: + /1.0/kb/subscriptions: + get: tags: - "Subscription" - summary: "Block a subscription" + summary: "Retrieve a subscription by external key" description: "" - operationId: "addSubscriptionBlockingState" - consumes: + operationId: "getSubscriptionByKey" + produces: - "application/json" parameters: - - name: "subscriptionId" - in: "path" + - name: "externalKey" + in: "query" 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: + $ref: "#/definitions/Subscription" + "404": + description: "Subscription not found" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + post: + tags: + - "Subscription" + summary: "Create a subscription" + description: "" + operationId: "createSubscription" + consumes: + - "application/json" + produces: + - "application/json" + parameters: - in: "body" name: "body" required: true schema: - $ref: "#/definitions/BlockingState" - - name: "requestedDate" + $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 @@ -9606,15 +9734,9 @@ paths: type: "string" responses: "201": - description: "Blocking state created successfully" + description: "Subscription created successfully" schema: - type: "array" - items: - $ref: "#/definitions/BlockingState" - "400": - description: "Invalid subscription id supplied" - "404": - description: "Subscription not found" + $ref: "#/definitions/Subscription" security: - basicAuth: [] - Killbill Api Key: [] @@ -9816,92 +9938,32 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/subscriptions: - get: - tags: - - "Subscription" - summary: "Retrieve a subscription by external key" - description: "" - operationId: "getSubscriptionByKey" - produces: - - "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" - responses: - "200": - description: "successful operation" - schema: - $ref: "#/definitions/Subscription" - "404": - description: "Subscription not found" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + /1.0/kb/subscriptions/{subscriptionId}/block: post: tags: - "Subscription" - summary: "Create a subscription" + summary: "Block a subscription" description: "" - operationId: "createSubscription" + operationId: "addSubscriptionBlockingState" 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: "entitlementDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "billingDate" + $ref: "#/definitions/BlockingState" + - name: "requestedDate" 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 @@ -9923,9 +9985,15 @@ paths: type: "string" responses: "201": - description: "Subscription created successfully" + description: "Blocking state created successfully" schema: - $ref: "#/definitions/Subscription" + type: "array" + items: + $ref: "#/definitions/BlockingState" + "400": + description: "Invalid subscription id supplied" + "404": + description: "Subscription not found" security: - basicAuth: [] - Killbill Api Key: [] @@ -10098,71 +10166,13 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/subscriptions/{subscriptionId}/auditLogsWithHistory: - get: - tags: - - "Subscription" - summary: "Retrieve subscription audit logs with history by id" - description: "" - operationId: "getSubscriptionAuditLogsWithHistory" - produces: - - "application/json" - parameters: - - name: "subscriptionId" - 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 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: + /1.0/kb/subscriptions/{subscriptionId}/undoChangePlan: put: tags: - "Subscription" - summary: "Un-cancel an entitlement" + summary: "Undo a pending change plan on an entitlement" description: "" - operationId: "uncancelSubscriptionPlan" + operationId: "undoChangeSubscriptionPlan" produces: - "application/json" parameters: @@ -10202,13 +10212,15 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/subscriptions/{subscriptionId}/undoChangePlan: + /1.0/kb/subscriptions/{subscriptionId}/bcd: put: tags: - "Subscription" - summary: "Undo a pending change plan on an entitlement" + summary: "Update the BCD associated to a subscription" description: "" - operationId: "undoChangeSubscriptionPlan" + operationId: "updateSubscriptionBCD" + consumes: + - "application/json" produces: - "application/json" parameters: @@ -10218,13 +10230,21 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "pluginProperty" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/Subscription" + - name: "effectiveFromDate" in: "query" required: false - type: "array" - items: - type: "string" - collectionFormat: "multi" + type: "string" + format: "date" + - name: "forceNewBcdWithPastEffectiveDate" + in: "query" + required: false + type: "boolean" + default: false - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -10241,22 +10261,18 @@ paths: "204": description: "Successful operation" "400": - description: "Invalid subscription id supplied" - "404": - description: "Entitlement not found" + description: "Invalid entitlement supplied" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/subscriptions/{subscriptionId}/bcd: + /1.0/kb/subscriptions/{subscriptionId}/uncancel: put: tags: - "Subscription" - summary: "Update the BCD associated to a subscription" + summary: "Un-cancel an entitlement" description: "" - operationId: "updateSubscriptionBCD" - consumes: - - "application/json" + operationId: "uncancelSubscriptionPlan" produces: - "application/json" parameters: @@ -10266,21 +10282,13 @@ paths: 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" + - name: "pluginProperty" in: "query" required: false - type: "boolean" - default: false + type: "array" + items: + type: "string" + collectionFormat: "multi" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -10297,7 +10305,9 @@ paths: "204": description: "Successful operation" "400": - description: "Invalid entitlement supplied" + description: "Invalid subscription id supplied" + "404": + description: "Entitlement not found" security: - basicAuth: [] - Killbill Api Key: [] @@ -10428,6 +10438,35 @@ paths: - 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/tagDefinitions: get: tags: @@ -10497,42 +10536,13 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/tagDefinitions/{tagDefinitionId}/auditLogsWithHistory: + /1.0/kb/tags/pagination: get: tags: - - "TagDefinition" - summary: "Retrieve tag definition audit logs with history by id" + - "Tag" + summary: "List tags" 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" - summary: "List tags" - description: "" - operationId: "getTags" + operationId: "getTags" produces: - "application/json" parameters: @@ -10644,71 +10654,6 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/tenants: - get: - tags: - - "Tenant" - summary: "Retrieve a tenant by its API key" - description: "" - operationId: "getTenantByApiKey" - produces: - - "application/json" - parameters: - - name: "apiKey" - in: "query" - required: false - type: "string" - 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" - security: - - basicAuth: [] /1.0/kb/tenants/uploadPluginPaymentStateMachineConfig/{pluginName}: get: tags: @@ -10812,35 +10757,37 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/tenants/uploadPerTenantConfig: + /1.0/kb/tenants: get: tags: - "Tenant" - summary: "Retrieve a per tenant configuration (system properties)" + summary: "Retrieve a tenant by its API key" description: "" - operationId: "getPerTenantConfiguration" + operationId: "getTenantByApiKey" produces: - "application/json" - parameters: [] + parameters: + - name: "apiKey" + in: "query" + required: false + type: "string" responses: "200": description: "successful operation" schema: - $ref: "#/definitions/TenantKeyValue" - "400": - description: "Invalid tenantId supplied" + $ref: "#/definitions/Tenant" + "404": + description: "Tenant not found" security: - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] post: tags: - "Tenant" - summary: "Add a per tenant configuration (system properties)" + summary: "Create a tenant" description: "" - operationId: "uploadPerTenantConfiguration" + operationId: "createTenant" consumes: - - "text/plain" + - "application/json" produces: - "application/json" parameters: @@ -10848,7 +10795,12 @@ paths: name: "body" required: true schema: - type: "string" + $ref: "#/definitions/Tenant" + - name: "useGlobalDefault" + in: "query" + required: false + type: "boolean" + default: false - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -10863,54 +10815,24 @@ paths: type: "string" responses: "201": - description: "Per tenant configuration uploaded successfully" + description: "Tenant created successfully" schema: - $ref: "#/definitions/TenantKeyValue" - "400": - description: "Invalid tenantId supplied" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - delete: - tags: - - "Tenant" - summary: "Delete a per tenant configuration (system properties)" - description: "" - 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" - responses: - "204": - description: "Successful operation" - "400": - description: "Invalid tenantId supplied" + $ref: "#/definitions/Tenant" + "409": + description: "Tenant already exists" security: - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/tenants/uploadPluginConfig/{pluginName}: + /1.0/kb/tenants/userKeyValue/{keyName}: get: tags: - "Tenant" - summary: "Retrieve a per tenant configuration for a plugin" + summary: "Retrieve a per tenant user key/value" description: "" - operationId: "getPluginConfiguration" + operationId: "getUserKeyValue" produces: - "application/json" parameters: - - name: "pluginName" + - name: "keyName" in: "path" required: true type: "string" @@ -10929,15 +10851,15 @@ paths: post: tags: - "Tenant" - summary: "Add a per tenant configuration for a plugin" + summary: "Add a per tenant user key/value" description: "" - operationId: "uploadPluginConfiguration" + operationId: "insertUserKeyValue" consumes: - "text/plain" produces: - "application/json" parameters: - - name: "pluginName" + - name: "keyName" in: "path" required: true type: "string" @@ -10961,7 +10883,7 @@ paths: type: "string" responses: "201": - description: "Plugin configuration uploaded successfully" + description: "Per tenant config uploaded successfully" schema: $ref: "#/definitions/TenantKeyValue" "400": @@ -10973,11 +10895,11 @@ paths: delete: tags: - "Tenant" - summary: "Delete a per tenant configuration for a plugin" + summary: "Delete a per tenant user key/value" description: "" - operationId: "deletePluginConfiguration" + operationId: "deleteUserKeyValue" parameters: - - name: "pluginName" + - name: "keyName" in: "path" required: true type: "string" @@ -11003,6 +10925,35 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] + /1.0/kb/tenants/{tenantId}: + get: + tags: + - "Tenant" + summary: "Retrieve a tenant by id" + description: "" + operationId: "getTenant" + produces: + - "application/json" + parameters: + - name: "tenantId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + responses: + "200": + description: "successful operation" + schema: + $ref: "#/definitions/Tenant" + "400": + description: "Invalid tenantId supplied" + "404": + description: "Tenant not found" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/tenants/registerNotificationCallback: get: tags: @@ -11090,17 +11041,17 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/tenants/userKeyValue/{keyName}: + /1.0/kb/tenants/uploadPluginConfig/{pluginName}: get: tags: - "Tenant" - summary: "Retrieve a per tenant user key/value" + summary: "Retrieve a per tenant configuration for a plugin" description: "" - operationId: "getUserKeyValue" + operationId: "getPluginConfiguration" produces: - "application/json" parameters: - - name: "keyName" + - name: "pluginName" in: "path" required: true type: "string" @@ -11119,15 +11070,15 @@ paths: post: tags: - "Tenant" - summary: "Add a per tenant user key/value" + summary: "Add a per tenant configuration for a plugin" description: "" - operationId: "insertUserKeyValue" + operationId: "uploadPluginConfiguration" consumes: - "text/plain" produces: - "application/json" parameters: - - name: "keyName" + - name: "pluginName" in: "path" required: true type: "string" @@ -11151,7 +11102,7 @@ paths: type: "string" responses: "201": - description: "Per tenant config uploaded successfully" + description: "Plugin configuration uploaded successfully" schema: $ref: "#/definitions/TenantKeyValue" "400": @@ -11163,11 +11114,11 @@ paths: delete: tags: - "Tenant" - summary: "Delete a per tenant user key/value" + summary: "Delete a per tenant configuration for a plugin" description: "" - operationId: "deleteUserKeyValue" + operationId: "deletePluginConfiguration" parameters: - - name: "keyName" + - name: "pluginName" in: "path" required: true type: "string" @@ -11221,42 +11172,101 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/tenants/{tenantId}: + /1.0/kb/tenants/uploadPerTenantConfig: get: tags: - "Tenant" - summary: "Retrieve a tenant by id" + summary: "Retrieve a per tenant configuration (system properties)" description: "" - operationId: "getTenant" + operationId: "getPerTenantConfiguration" produces: - "application/json" - parameters: - - name: "tenantId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" + parameters: [] responses: "200": description: "successful operation" schema: - $ref: "#/definitions/Tenant" + $ref: "#/definitions/TenantKeyValue" "400": description: "Invalid tenantId supplied" - "404": - description: "Tenant not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/paymentTransactions/{transactionId}/tags: - get: + post: tags: - - "PaymentTransaction" - summary: "Retrieve payment transaction tags" + - "Tenant" + summary: "Add a per tenant configuration (system properties)" description: "" - operationId: "getTransactionTags" + operationId: "uploadPerTenantConfiguration" + consumes: + - "text/plain" + produces: + - "application/json" + parameters: + - 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: "Per tenant configuration uploaded successfully" + schema: + $ref: "#/definitions/TenantKeyValue" + "400": + description: "Invalid tenantId supplied" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + delete: + tags: + - "Tenant" + summary: "Delete a per tenant configuration (system properties)" + description: "" + 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" + responses: + "204": + description: "Successful operation" + "400": + description: "Invalid tenantId supplied" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/paymentTransactions/{transactionId}/customFields: + get: + tags: + - "PaymentTransaction" + summary: "Retrieve payment transaction custom fields" + description: "" + operationId: "getTransactionCustomFields" produces: - "application/json" parameters: @@ -11266,11 +11276,6 @@ paths: 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 @@ -11286,11 +11291,9 @@ paths: 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: [] @@ -11298,9 +11301,9 @@ paths: post: tags: - "PaymentTransaction" - summary: "Add tags to payment transaction" + summary: "Add custom fields to payment transaction" description: "" - operationId: "createTransactionTags" + operationId: "createTransactionCustomFields" consumes: - "application/json" produces: @@ -11318,8 +11321,7 @@ paths: schema: type: "array" items: - type: "string" - format: "uuid" + $ref: "#/definitions/CustomField" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -11334,23 +11336,23 @@ paths: type: "string" responses: "201": - description: "Tag created successfully" + description: "Custom field created successfully" schema: type: "array" items: - $ref: "#/definitions/Tag" + $ref: "#/definitions/CustomField" "400": description: "Invalid transaction id supplied" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - delete: + put: tags: - "PaymentTransaction" - summary: "Remove tags from payment transaction" + summary: "Modify custom fields to payment transaction" description: "" - operationId: "deleteTransactionTags" + operationId: "modifyTransactionCustomFields" consumes: - "application/json" produces: @@ -11362,14 +11364,13 @@ paths: 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" + - in: "body" + name: "body" + required: true + schema: + type: "array" + items: + $ref: "#/definitions/CustomField" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -11391,13 +11392,14 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/paymentTransactions/{transactionId}/customFields: - get: + delete: tags: - "PaymentTransaction" - summary: "Retrieve payment transaction custom fields" + summary: "Remove custom fields from payment transaction" description: "" - operationId: "getTransactionCustomFields" + operationId: "deleteTransactionCustomFields" + consumes: + - "application/json" produces: - "application/json" parameters: @@ -11407,36 +11409,42 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "audit" + - 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" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" responses: - "200": - description: "successful operation" - schema: - type: "array" - items: - $ref: "#/definitions/CustomField" + "204": + description: "Successful operation" "400": description: "Invalid transaction id supplied" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - post: + /1.0/kb/paymentTransactions/{transactionId}/tags: + get: tags: - "PaymentTransaction" - summary: "Add custom fields to payment transaction" + summary: "Retrieve payment transaction tags" description: "" - operationId: "createTransactionCustomFields" - consumes: - - "application/json" + operationId: "getTransactionTags" produces: - "application/json" parameters: @@ -11446,44 +11454,41 @@ paths: 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" + - name: "includedDeleted" + in: "query" required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" + 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" + $ref: "#/definitions/Tag" "400": description: "Invalid transaction id supplied" + "404": + description: "Invoice not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - put: + post: tags: - "PaymentTransaction" - summary: "Modify custom fields to payment transaction" + summary: "Add tags to payment transaction" description: "" - operationId: "modifyTransactionCustomFields" + operationId: "createTransactionTags" consumes: - "application/json" produces: @@ -11501,7 +11506,8 @@ paths: schema: type: "array" items: - $ref: "#/definitions/CustomField" + type: "string" + format: "uuid" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -11515,8 +11521,12 @@ paths: required: false type: "string" responses: - "204": - description: "Successful operation" + "201": + description: "Tag created successfully" + schema: + type: "array" + items: + $ref: "#/definitions/Tag" "400": description: "Invalid transaction id supplied" security: @@ -11526,9 +11536,9 @@ paths: delete: tags: - "PaymentTransaction" - summary: "Remove custom fields from payment transaction" + summary: "Remove tags from payment transaction" description: "" - operationId: "deleteTransactionCustomFields" + operationId: "deleteTransactionTags" consumes: - "application/json" produces: @@ -11540,7 +11550,7 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "customField" + - name: "tagDef" in: "query" required: false type: "array" @@ -11953,135 +11963,29 @@ definitions: id: type: "string" format: "uuid" - Tag: + Payment: type: "object" properties: - tagId: + accountId: 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" - objectId: + paymentId: type: "string" format: "uuid" - tagDefinitionId: + paymentNumber: type: "string" - format: "uuid" - tagDefinitionName: + paymentExternalKey: type: "string" - 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" - 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" - Account: - type: "object" - properties: - accountId: - type: "string" - format: "uuid" - name: - type: "string" - firstNameLength: - type: "integer" - format: "int32" - externalKey: - type: "string" - email: - 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: @@ -12250,91 +12154,58 @@ definitions: - "ZMW" - "ZWD" - "BTC" - parentAccountId: - type: "string" - format: "uuid" - isPaymentDelegatedToParent: - type: "boolean" 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: + transactions: type: "array" items: - $ref: "#/definitions/AuditLog" - AccountEmail: - type: "object" - required: - - "email" - properties: - accountId: - type: "string" - format: "uuid" - email: - type: "string" + $ref: "#/definitions/PaymentTransaction" + paymentAttempts: + type: "array" + items: + $ref: "#/definitions/PaymentAttempt" auditLogs: type: "array" items: $ref: "#/definitions/AuditLog" - InvoicePayment: + PaymentAttempt: type: "object" properties: - targetInvoiceId: + accountId: type: "string" format: "uuid" - accountId: + paymentMethodId: type: "string" format: "uuid" - paymentId: + paymentExternalKey: + type: "string" + transactionId: type: "string" format: "uuid" - paymentNumber: + transactionExternalKey: type: "string" - paymentExternalKey: + transactionType: type: "string" - authAmount: - type: "number" - capturedAmount: - type: "number" - purchasedAmount: - type: "number" - refundedAmount: - type: "number" - creditedAmount: + 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" @@ -12501,36 +12372,29 @@ definitions: - "ZMW" - "ZWD" - "BTC" - paymentMethodId: + pluginName: type: "string" - format: "uuid" - transactions: - type: "array" - items: - $ref: "#/definitions/PaymentTransaction" - paymentAttempts: + pluginProperties: type: "array" items: - $ref: "#/definitions/PaymentAttempt" + $ref: "#/definitions/PluginProperty" auditLogs: type: "array" items: $ref: "#/definitions/AuditLog" - PaymentAttempt: + PaymentTransaction: type: "object" properties: - accountId: - type: "string" - format: "uuid" - paymentMethodId: + transactionId: type: "string" format: "uuid" - paymentExternalKey: + transactionExternalKey: type: "string" - transactionId: + paymentId: type: "string" format: "uuid" - transactionExternalKey: + description: "Associated payment id, required when notifying state transitions" + paymentExternalKey: type: "string" transactionType: type: "string" @@ -12542,11 +12406,6 @@ definitions: - "PURCHASE" - "REFUND" - "VOID" - effectiveDate: - type: "string" - format: "date-time" - stateName: - type: "string" amount: type: "number" description: "Transaction amount, required except for void operations" @@ -12719,47 +12578,14 @@ definitions: - "ZMW" - "ZWD" - "BTC" - pluginName: - type: "string" - pluginProperties: - type: "array" - items: - $ref: "#/definitions/PluginProperty" - auditLogs: - type: "array" - items: - $ref: "#/definitions/AuditLog" - PaymentTransaction: - 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: + effectiveDate: type: "string" - transactionType: + format: "date-time" + processedAmount: + type: "number" + processedCurrency: 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" @@ -12925,12 +12751,179 @@ definitions: - "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" + 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" - processedAmount: + type: + type: "string" + enum: + - "SUBSCRIPTION" + - "SUBSCRIPTION_BUNDLE" + - "ACCOUNT" + auditLogs: + type: "array" + items: + $ref: "#/definitions/AuditLog" + Tag: + type: "object" + properties: + tagId: + 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" + objectId: + type: "string" + format: "uuid" + tagDefinitionId: + type: "string" + format: "uuid" + tagDefinitionName: + type: "string" + auditLogs: + type: "array" + items: + $ref: "#/definitions/AuditLog" + InvoicePayment: + type: "object" + properties: + targetInvoiceId: + type: "string" + format: "uuid" + accountId: + type: "string" + format: "uuid" + paymentId: + type: "string" + format: "uuid" + paymentNumber: + type: "string" + paymentExternalKey: + type: "string" + authAmount: type: "number" - processedCurrency: + capturedAmount: + type: "number" + purchasedAmount: + type: "number" + refundedAmount: + type: "number" + creditedAmount: + type: "number" + currency: type: "string" enum: - "AED" @@ -13098,81 +13091,258 @@ definitions: - "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: + paymentMethodId: type: "string" - properties: + format: "uuid" + transactions: type: "array" items: - $ref: "#/definitions/PluginProperty" + $ref: "#/definitions/PaymentTransaction" + paymentAttempts: + type: "array" + items: + $ref: "#/definitions/PaymentAttempt" auditLogs: type: "array" items: $ref: "#/definitions/AuditLog" - PluginProperty: - type: "object" - properties: - key: - type: "string" - value: - type: "string" - isUpdatable: - type: "boolean" - PaymentMethod: + Account: type: "object" properties: - paymentMethodId: - type: "string" - format: "uuid" - externalKey: - type: "string" accountId: type: "string" format: "uuid" - isDefault: - type: "boolean" - pluginName: + name: type: "string" - pluginInfo: - $ref: "#/definitions/PaymentMethodPluginDetail" - auditLogs: - type: "array" - items: - $ref: "#/definitions/AuditLog" - PaymentMethodPluginDetail: - type: "object" - properties: - externalPaymentMethodId: + firstNameLength: + type: "integer" + format: "int32" + externalKey: type: "string" - isDefaultPaymentMethod: - type: "boolean" - properties: - type: "array" - items: - $ref: "#/definitions/PluginProperty" - BlockPrice: - type: "object" - properties: - unitName: + email: type: "string" - size: - type: "number" - price: + 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" + parentAccountId: + type: "string" + format: "uuid" + isPaymentDelegatedToParent: + type: "boolean" + 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" + BlockPrice: + type: "object" + properties: + unitName: + type: "string" + size: + type: "number" + price: type: "number" max: type: "number" @@ -13443,23 +13613,6 @@ definitions: 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: @@ -13952,29 +14105,114 @@ definitions: reevaluationIntervalDays: type: "integer" format: "int32" - Payment: + 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" + AccountEmail: + type: "object" + required: + - "email" + properties: + accountId: + type: "string" + format: "uuid" + email: + 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" + AdminPayment: + type: "object" + properties: + lastSuccessPaymentState: + type: "string" + currentPaymentStateName: + type: "string" + transactionStatus: + 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" + Price: type: "object" properties: - accountId: - type: "string" - format: "uuid" - paymentId: - type: "string" - format: "uuid" - paymentNumber: - type: "string" - paymentExternalKey: - type: "string" - authAmount: - type: "number" - capturedAmount: - type: "number" - purchasedAmount: - type: "number" - refundedAmount: - type: "number" - creditedAmount: - type: "number" currency: type: "string" enum: @@ -14143,54 +14381,181 @@ definitions: - "ZMW" - "ZWD" - "BTC" - paymentMethodId: + value: + type: "number" + PriceList: + type: "object" + properties: + name: type: "string" - format: "uuid" - transactions: + plans: type: "array" items: - $ref: "#/definitions/PaymentTransaction" - paymentAttempts: + type: "string" + Duration: + type: "object" + properties: + unit: + type: "string" + enum: + - "DAYS" + - "WEEKS" + - "MONTHS" + - "YEARS" + - "UNLIMITED" + number: + type: "integer" + format: "int32" + Limit: + type: "object" + properties: + unit: + type: "string" + max: + type: "string" + min: + type: "string" + Phase: + type: "object" + properties: + type: + type: "string" + prices: type: "array" items: - $ref: "#/definitions/PaymentAttempt" - auditLogs: + $ref: "#/definitions/Price" + fixedPrices: type: "array" items: - $ref: "#/definitions/AuditLog" - AdminPayment: + $ref: "#/definitions/Price" + duration: + $ref: "#/definitions/Duration" + usages: + type: "array" + items: + $ref: "#/definitions/Usage" + Plan: type: "object" properties: - lastSuccessPaymentState: + name: type: "string" - currentPaymentStateName: + prettyName: type: "string" - transactionStatus: + recurringBillingMode: type: "string" - SimplePlan: + 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" + Product: type: "object" properties: - planId: + type: type: "string" - productName: + name: type: "string" - productCategory: + prettyName: type: "string" - enum: - - "BASE" - - "ADD_ON" - - "STANDALONE" - currency: + plans: + type: "array" + items: + $ref: "#/definitions/Plan" + included: + type: "array" + items: + type: "string" + available: + type: "array" + items: + type: "string" + Tier: + type: "object" + properties: + limits: + type: "array" + items: + $ref: "#/definitions/Limit" + fixedPrice: + type: "array" + items: + $ref: "#/definitions/Price" + recurringPrice: + type: "array" + items: + $ref: "#/definitions/Price" + blocks: + type: "array" + items: + $ref: "#/definitions/TieredBlock" + TieredBlock: + type: "object" + properties: + unit: type: "string" - enum: - - "AED" - - "AFN" - - "ALL" - - "AMD" - - "ANG" - - "AOA" - - "ARS" - - "AUD" + size: + type: "string" + max: + type: "string" + prices: + type: "array" + items: + $ref: "#/definitions/Price" + Usage: + type: "object" + properties: + billingPeriod: + type: "string" + tiers: + type: "array" + items: + $ref: "#/definitions/Tier" + 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" @@ -14385,212 +14750,18 @@ definitions: type: "array" items: type: "string" - PlanDetail: + CatalogValidation: 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: + catalogValidationErrors: type: "array" items: - $ref: "#/definitions/Price" - Price: + $ref: "#/definitions/CatalogValidationError" + CatalogValidationError: type: "object" properties: - currency: + errorDescription: 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" Catalog: type: "object" properties: @@ -14658,269 +14829,129 @@ definitions: - "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" - number: - type: "integer" - format: "int32" - Limit: - type: "object" - properties: - unit: - type: "string" - max: - type: "string" - min: - type: "string" - Phase: - type: "object" - properties: - type: - type: "string" - prices: - type: "array" - items: - $ref: "#/definitions/Price" - fixedPrices: - type: "array" - items: - $ref: "#/definitions/Price" - duration: - $ref: "#/definitions/Duration" - usages: - type: "array" - items: - $ref: "#/definitions/Usage" - Plan: - type: "object" - properties: - name: - 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: - 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/Plan" - included: - type: "array" - items: - type: "string" - available: - type: "array" - items: - type: "string" - Tier: - type: "object" - properties: - limits: - type: "array" - items: - $ref: "#/definitions/Limit" - fixedPrice: - type: "array" - items: - $ref: "#/definitions/Price" - recurringPrice: + - "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/Price" - blocks: + $ref: "#/definitions/Unit" + products: type: "array" items: - $ref: "#/definitions/TieredBlock" - TieredBlock: - type: "object" - properties: - unit: - type: "string" - size: - type: "string" - max: - type: "string" - prices: + $ref: "#/definitions/Product" + priceLists: type: "array" items: - $ref: "#/definitions/Price" + $ref: "#/definitions/PriceList" Unit: type: "object" properties: @@ -14928,27 +14959,6 @@ definitions: type: "string" prettyName: type: "string" - Usage: - type: "object" - properties: - billingPeriod: - type: "string" - tiers: - type: "array" - items: - $ref: "#/definitions/Tier" - CatalogValidation: - type: "object" - properties: - catalogValidationErrors: - type: "array" - items: - $ref: "#/definitions/CatalogValidationError" - CatalogValidationError: - type: "object" - properties: - errorDescription: - type: "string" InvoicePaymentTransaction: type: "object" properties: @@ -15432,24 +15442,6 @@ definitions: $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: @@ -15502,6 +15494,24 @@ 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: @@ -15607,13 +15617,6 @@ definitions: type: "array" items: $ref: "#/definitions/AuditLog" - HostedPaymentPageFields: - type: "object" - properties: - formFields: - type: "array" - items: - $ref: "#/definitions/PluginProperty" ComboHostedPaymentPage: type: "object" properties: @@ -15631,6 +15634,13 @@ definitions: type: "array" items: $ref: "#/definitions/AuditLog" + HostedPaymentPageFields: + type: "object" + properties: + formFields: + type: "array" + items: + $ref: "#/definitions/PluginProperty" ComboPaymentTransaction: type: "object" properties: @@ -15652,33 +15662,6 @@ 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: @@ -15706,6 +15689,33 @@ 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: diff --git a/src/main/java/org/killbill/billing/client/api/gen/InvoiceApi.java b/src/main/java/org/killbill/billing/client/api/gen/InvoiceApi.java index a85e905..4d7b919 100644 --- a/src/main/java/org/killbill/billing/client/api/gen/InvoiceApi.java +++ b/src/main/java/org/killbill/billing/client/api/gen/InvoiceApi.java @@ -602,11 +602,20 @@ public Tags getInvoiceTags(final UUID invoiceId, final Boolean includedDeleted, } public String getInvoiceTemplate(final RequestOptions inputOptions) throws KillBillClientException { + return getInvoiceTemplate(Boolean.valueOf(false), inputOptions); + } + + public String getInvoiceTemplate(final Boolean templateWithBrandInfo, final RequestOptions inputOptions) throws KillBillClientException { final String uri = "/1.0/kb/invoices/template"; + final Multimap queryParams = new TreeMapSetMultimap<>(inputOptions.getQueryParams()); + if (templateWithBrandInfo != null) { + queryParams.put("templateWithBrandInfo", String.valueOf(templateWithBrandInfo)); + } final RequestOptionsBuilder inputOptionsBuilder = inputOptions.extend(); + inputOptionsBuilder.withQueryParams(queryParams.asMap()); inputOptionsBuilder.withHeader(KillBillHttpClient.HTTP_HEADER_ACCEPT, "text/html"); final RequestOptions requestOptions = inputOptionsBuilder.build(); @@ -811,10 +820,10 @@ public String uploadInvoiceMPTemplate(final String body, final Boolean deleteIfE } public String uploadInvoiceTemplate(final String body, final RequestOptions inputOptions) throws KillBillClientException { - return uploadInvoiceTemplate(body, Boolean.valueOf(false), inputOptions); + return uploadInvoiceTemplate(body, Boolean.valueOf(false), Boolean.valueOf(false), inputOptions); } - public String uploadInvoiceTemplate(final String body, final Boolean deleteIfExists, final RequestOptions inputOptions) throws KillBillClientException { + public String uploadInvoiceTemplate(final String body, final Boolean deleteIfExists, final Boolean templateWithBrandInfo, final RequestOptions inputOptions) throws KillBillClientException { Preconditions.checkNotNull(body, "Missing the required parameter 'body' when calling uploadInvoiceTemplate"); final String uri = "/1.0/kb/invoices/template"; @@ -823,6 +832,9 @@ public String uploadInvoiceTemplate(final String body, final Boolean deleteIfExi if (deleteIfExists != null) { queryParams.put("deleteIfExists", String.valueOf(deleteIfExists)); } + if (templateWithBrandInfo != null) { + queryParams.put("templateWithBrandInfo", String.valueOf(templateWithBrandInfo)); + } final RequestOptionsBuilder inputOptionsBuilder = inputOptions.extend(); final Boolean followLocation = Objects.requireNonNullElse(inputOptions.getFollowLocation(), Boolean.TRUE);