diff --git a/.swagger-codegen/kbswagger.yaml b/.swagger-codegen/kbswagger.yaml index 29b08a7..6a0069b 100644 --- a/.swagger-codegen/kbswagger.yaml +++ b/.swagger-codegen/kbswagger.yaml @@ -34,40 +34,76 @@ tags: - name: "PaymentTransaction" - name: "Usage" paths: - /1.0/kb/accounts/payments: - post: + /1.0/kb/accounts/{childAccountId}/transferCredit: + put: tags: - "Account" - summary: "Trigger a payment using the account external key (authorization, purchase\ - \ or credit)" + summary: "Move a given child credit to the parent level" description: "" - operationId: "processPaymentByExternalKey" + operationId: "transferChildCreditToParent" consumes: - "application/json" produces: - "application/json" parameters: - - in: "body" - name: "body" + - name: "childAccountId" + in: "path" required: true - schema: - $ref: "#/definitions/PaymentTransaction" - - name: "externalKey" - in: "query" + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "X-Killbill-CreatedBy" + in: "header" required: true type: "string" - - name: "paymentMethodId" - in: "query" + - 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}/paymentMethods/{paymentMethodId}/setDefault: + put: + tags: + - "Account" + summary: "Set the default payment method" + description: "" + operationId: "setDefaultPaymentMethod" + consumes: + - "application/json" + produces: + - "application/json" + parameters: + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "controlPluginName" + - name: "paymentMethodId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "payAllUnpaidInvoices" in: "query" required: false - type: "array" - items: - type: "string" - collectionFormat: "multi" + type: "boolean" + default: false - name: "pluginProperty" in: "query" required: false @@ -88,37 +124,23 @@ paths: required: false type: "string" responses: - "201": - description: "Payment transaction created successfully" - schema: - $ref: "#/definitions/Payment" + "204": + description: "Successful operation" "400": - description: "Invalid account external key supplied" + description: "Invalid account id or payment method id supplied" "404": description: "Account not found" - "402": - description: "Transaction declined by gateway" - "422": - description: "Payment is aborted by a control plugin" - "502": - description: "Failed to submit payment transaction" - "503": - description: "Payment in unknown status, failed to receive gateway response" - "504": - description: "Payment operation timeout" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/cbaRebalancing: + /1.0/kb/accounts/{accountId}/paymentMethods/refresh: put: tags: - "Account" - summary: "Rebalance account CBA" + summary: "Refresh account payment methods" description: "" - operationId: "rebalanceExistingCBAOnAccount" - consumes: - - "application/json" + operationId: "refreshPaymentMethods" produces: - "application/json" parameters: @@ -128,6 +150,17 @@ paths: 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 @@ -145,17 +178,19 @@ paths: description: "Successful operation" "400": description: "Invalid account id supplied" + "404": + description: "Account not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/customFields: + /1.0/kb/accounts/{accountId}/emails: get: tags: - "Account" - summary: "Retrieve account custom fields" + summary: "Retrieve an account emails" description: "" - operationId: "getAccountCustomFields" + operationId: "getEmails" produces: - "application/json" parameters: @@ -165,22 +200,13 @@ 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" + $ref: "#/definitions/AccountEmail" "400": description: "Invalid account id supplied" security: @@ -190,9 +216,9 @@ paths: post: tags: - "Account" - summary: "Add custom fields to account" + summary: "Add account email" description: "" - operationId: "createAccountCustomFields" + operationId: "addEmail" consumes: - "application/json" produces: @@ -208,9 +234,7 @@ paths: name: "body" required: true schema: - type: "array" - items: - $ref: "#/definitions/CustomField" + $ref: "#/definitions/AccountEmail" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -225,87 +249,79 @@ paths: type: "string" responses: "201": - description: "Custom field created successfully" + description: "Email created successfully" schema: type: "array" items: - $ref: "#/definitions/CustomField" + $ref: "#/definitions/AccountEmail" "400": description: "Invalid account id supplied" + "404": + description: "Account not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - put: + /1.0/kb/accounts: + get: tags: - "Account" - summary: "Modify custom fields to account" + summary: "Retrieve an account by external key" description: "" - operationId: "modifyAccountCustomFields" - consumes: - - "application/json" + operationId: "getAccountByKey" 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/CustomField" - - name: "X-Killbill-CreatedBy" - in: "header" + - name: "externalKey" + in: "query" required: true type: "string" - - name: "X-Killbill-Reason" - in: "header" + - name: "accountWithBalance" + in: "query" required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" + 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" - "400": - description: "Invalid account id supplied" + "200": + description: "successful operation" + schema: + $ref: "#/definitions/Account" + "404": + description: "Account not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - delete: + post: tags: - "Account" - summary: "Remove custom fields from account" + summary: "Create account" description: "" - operationId: "deleteAccountCustomFields" + 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: "customField" - in: "query" - required: false - type: "array" - items: - type: "string" - format: "uuid" - collectionFormat: "multi" + schema: + $ref: "#/definitions/Account" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -319,21 +335,23 @@ paths: required: false type: "string" responses: - "204": - description: "Successful operation" + "201": + description: "Account created successfully" + schema: + $ref: "#/definitions/Account" "400": - description: "Invalid account id supplied" + description: "Invalid account data supplied" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/auditLogs: + /1.0/kb/accounts/{accountId}: get: tags: - "Account" - summary: "Retrieve audit logs by account id" + summary: "Retrieve an account by id" description: "" - operationId: "getAccountAuditLogs" + operationId: "getAccount" produces: - "application/json" parameters: @@ -343,26 +361,46 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" + - name: "accountWithBalance" + in: "query" + required: false + type: "boolean" + default: false + - name: "accountWithBalanceAndCBA" + in: "query" + required: false + type: "boolean" + default: false + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" schema: - type: "array" - items: - $ref: "#/definitions/AuditLog" + $ref: "#/definitions/Account" + "400": + description: "Invalid account id supplied" "404": description: "Account not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/block: - get: + put: tags: - "Account" - summary: "Retrieve blocking states for account" + summary: "Update account" description: "" - operationId: "getBlockingStates" + operationId: "updateAccount" + consumes: + - "application/json" produces: - "application/json" parameters: @@ -372,53 +410,44 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "blockingStateTypes" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/Account" + - name: "treatNullAsReset" in: "query" required: false - type: "array" - items: - type: "string" - enum: - - "SUBSCRIPTION" - - "SUBSCRIPTION_BUNDLE" - - "ACCOUNT" - collectionFormat: "multi" - - name: "blockingStateSvcs" - in: "query" + type: "boolean" + default: false + - 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: - type: "array" - items: - $ref: "#/definitions/BlockingState" + "204": + description: "Successful operation" "400": - description: "Invalid account id supplied" + description: "Invalid account data supplied" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - post: + delete: tags: - "Account" - summary: "Block an account" + summary: "Close account" description: "" - operationId: "addAccountBlockingState" - consumes: + operationId: "closeAccount" + produces: - "application/json" parameters: - name: "accountId" @@ -427,23 +456,26 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/BlockingState" - - name: "requestedDate" + - name: "cancelAllSubscriptions" in: "query" required: false - type: "string" - format: "date" - - name: "pluginProperty" + type: "boolean" + default: false + - name: "writeOffUnpaidInvoices" in: "query" required: false - type: "array" - items: - type: "string" - collectionFormat: "multi" + type: "boolean" + default: false + - name: "itemAdjustUnpaidInvoices" + in: "query" + required: false + type: "boolean" + default: false + - name: "removeFutureNotifications" + in: "query" + required: false + type: "boolean" + default: true - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -457,56 +489,78 @@ 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 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/search/{searchKey}: get: tags: - "Account" - summary: "Retrieve blocking state audit logs with history by id" + summary: "Search accounts" description: "" - operationId: "getBlockingStateAuditLogsWithHistory" + operationId: "searchAccounts" produces: - "application/json" parameters: - - name: "blockingId" + - 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: "accountWithBalance" + in: "query" + required: false + type: "boolean" + default: false + - name: "accountWithBalanceAndCBA" + in: "query" + required: false + type: "boolean" + default: false + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/AuditLog" - "404": - description: "Blocking state not found" + $ref: "#/definitions/Account" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/emails/{accountEmailId}/auditLogsWithHistory: - get: + /1.0/kb/accounts/{accountId}/emails/{email}: + delete: tags: - "Account" - summary: "Retrieve account email audit logs with history by id" + summary: "Delete email from account" description: "" - operationId: "getAccountEmailAuditLogsWithHistory" + operationId: "removeEmail" produces: - "application/json" parameters: @@ -516,32 +570,90 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "accountEmailId" + - name: "email" in: "path" required: true type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "204": + description: "Successful operation" + "400": + description: "Invalid 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/AuditLog" - "404": - description: "Account not found" + $ref: "#/definitions/Account" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/tags: + /1.0/kb/accounts/{accountId}/customFields: get: tags: - "Account" - summary: "Retrieve account tags" + summary: "Retrieve account custom fields" description: "" - operationId: "getAccountTags" + operationId: "getAccountCustomFields" produces: - "application/json" parameters: @@ -551,11 +663,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 @@ -571,11 +678,9 @@ paths: schema: type: "array" items: - $ref: "#/definitions/Tag" + $ref: "#/definitions/CustomField" "400": description: "Invalid account id supplied" - "404": - description: "Account not found" security: - basicAuth: [] - Killbill Api Key: [] @@ -583,9 +688,9 @@ paths: post: tags: - "Account" - summary: "Add tags to account" + summary: "Add custom fields to account" description: "" - operationId: "createAccountTags" + operationId: "createAccountCustomFields" consumes: - "application/json" produces: @@ -603,8 +708,7 @@ paths: schema: type: "array" items: - type: "string" - format: "uuid" + $ref: "#/definitions/CustomField" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -619,11 +723,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 account id supplied" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + put: + tags: + - "Account" + summary: "Modify custom fields to account" + description: "" + operationId: "modifyAccountCustomFields" + 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: + $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 account id supplied" security: @@ -633,9 +782,9 @@ paths: delete: tags: - "Account" - summary: "Remove tags from account" + summary: "Remove custom fields from account" description: "" - operationId: "deleteAccountTags" + operationId: "deleteAccountCustomFields" consumes: - "application/json" produces: @@ -647,7 +796,7 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "tagDef" + - name: "customField" in: "query" required: false type: "array" @@ -671,19 +820,18 @@ 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: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/invoicePayments: + /1.0/kb/accounts/{accountId}/block: get: tags: - "Account" - summary: "Retrieve account invoice payments" + summary: "Retrieve blocking states for account" description: "" - operationId: "getInvoicePayments" + operationId: "getBlockingStates" produces: - "application/json" parameters: @@ -693,17 +841,18 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "withPluginInfo" - in: "query" - required: false - type: "boolean" - default: false - - name: "withAttempts" + - name: "blockingStateTypes" in: "query" required: false - type: "boolean" - default: false - - name: "pluginProperty" + type: "array" + items: + type: "string" + enum: + - "SUBSCRIPTION" + - "SUBSCRIPTION_BUNDLE" + - "ACCOUNT" + collectionFormat: "multi" + - name: "blockingStateSvcs" in: "query" required: false type: "array" @@ -725,11 +874,9 @@ paths: schema: type: "array" items: - $ref: "#/definitions/InvoicePayment" + $ref: "#/definitions/BlockingState" "400": description: "Invalid account id supplied" - "404": - description: "Account not found" security: - basicAuth: [] - Killbill Api Key: [] @@ -737,13 +884,11 @@ paths: post: tags: - "Account" - summary: "Trigger a payment for all unpaid invoices" + summary: "Block an account" description: "" - operationId: "payAllInvoices" + operationId: "addAccountBlockingState" consumes: - "application/json" - produces: - - "application/json" parameters: - name: "accountId" in: "path" @@ -751,21 +896,12 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "paymentMethodId" - in: "query" - required: false - type: "string" - format: "uuid" - - name: "externalPayment" - in: "query" - required: false - type: "boolean" - default: false - - name: "paymentAmount" - in: "query" - required: false - type: "number" - - name: "targetDate" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/BlockingState" + - name: "requestedDate" in: "query" required: false type: "string" @@ -791,26 +927,55 @@ paths: type: "string" responses: "201": - description: "Successful operation" + description: "Blocking state created successfully" schema: type: "array" items: - $ref: "#/definitions/Invoice" - "204": - description: "Nothing to pay" - "404": + $ref: "#/definitions/BlockingState" + "400": description: "Invalid account id supplied" + "404": + description: "Account not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}: + /1.0/kb/accounts/block/{blockingId}/auditLogsWithHistory: get: tags: - "Account" - summary: "Retrieve an account by id" + summary: "Retrieve blocking state audit logs with history by id" description: "" - operationId: "getAccount" + 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: @@ -820,12 +985,42 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "accountWithBalance" - in: "query" - required: false - type: "boolean" - default: false - - name: "accountWithBalanceAndCBA" + - name: "accountEmailId" + 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}/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" @@ -843,7 +1038,9 @@ paths: "200": description: "successful operation" schema: - $ref: "#/definitions/Account" + type: "array" + items: + $ref: "#/definitions/Tag" "400": description: "Invalid account id supplied" "404": @@ -852,12 +1049,12 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - put: + post: tags: - "Account" - summary: "Update account" + summary: "Add tags to account" description: "" - operationId: "updateAccount" + operationId: "createAccountTags" consumes: - "application/json" produces: @@ -873,12 +1070,10 @@ paths: name: "body" required: true schema: - $ref: "#/definitions/Account" - - name: "treatNullAsReset" - in: "query" - required: false - type: "boolean" - default: false + type: "array" + items: + type: "string" + format: "uuid" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -892,10 +1087,14 @@ 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 account data supplied" + description: "Invalid account id supplied" security: - basicAuth: [] - Killbill Api Key: [] @@ -903,9 +1102,11 @@ paths: delete: tags: - "Account" - summary: "Close account" + summary: "Remove tags from account" description: "" - operationId: "closeAccount" + operationId: "deleteAccountTags" + consumes: + - "application/json" produces: - "application/json" parameters: @@ -915,32 +1116,20 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "cancelAllSubscriptions" + - name: "tagDef" in: "query" required: false - type: "boolean" - default: false - - name: "writeOffUnpaidInvoices" - in: "query" - required: false - type: "boolean" - default: false - - name: "itemAdjustUnpaidInvoices" - in: "query" - required: false - type: "boolean" - default: false - - name: "removeFutureNotifications" - in: "query" - required: false - type: "boolean" - default: true - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" + 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" @@ -951,18 +1140,19 @@ paths: "204": description: "Successful operation" "400": - description: "Invalid account id supplied" + 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}/bundles: + /1.0/kb/accounts/{accountId}/invoices/pagination: get: tags: - "Account" - summary: "Retrieve bundles for account" + summary: "Retrieve paginated invoices for account" description: "" - operationId: "getAccountBundles" + operationId: "getInvoicesForAccountPaginated" produces: - "application/json" parameters: @@ -972,14 +1162,18 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "externalKey" + - name: "offset" in: "query" required: false - type: "string" - - name: "bundlesFilter" + type: "integer" + default: 0 + format: "int64" + - name: "limit" in: "query" required: false - type: "string" + type: "integer" + default: 100 + format: "int64" - name: "audit" in: "query" required: false @@ -995,7 +1189,7 @@ paths: schema: type: "array" items: - $ref: "#/definitions/Bundle" + $ref: "#/definitions/Invoice" "400": description: "Invalid account id supplied" "404": @@ -1004,83 +1198,28 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/payments: - get: - tags: - - "Account" - summary: "Retrieve account payments" - description: "" - operationId: "getPaymentsForAccount" - produces: - - "application/json" - parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "withAttempts" - in: "query" - required: false - type: "boolean" - default: false - - name: "withPluginInfo" - in: "query" - required: false - type: "boolean" - default: false - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: - 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" - "400": - description: "Invalid account id supplied" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + /1.0/kb/accounts/payments: post: tags: - "Account" - summary: "Trigger a payment (authorization, purchase or credit)" + summary: "Trigger a payment using the account external key (authorization, purchase\ + \ or credit)" description: "" - operationId: "processPayment" + 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: $ref: "#/definitions/PaymentTransaction" + - name: "externalKey" + in: "query" + required: true + type: "string" - name: "paymentMethodId" in: "query" required: false @@ -1118,7 +1257,7 @@ paths: schema: $ref: "#/definitions/Payment" "400": - description: "Invalid account id supplied" + description: "Invalid account external key supplied" "404": description: "Account not found" "402": @@ -1135,13 +1274,13 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/overdue: + /1.0/kb/accounts/{accountId}/invoices: get: tags: - "Account" - summary: "Retrieve overdue state for account" + summary: "Retrieve account invoices" description: "" - operationId: "getOverdueAccount" + operationId: "getInvoicesForAccount" produces: - "application/json" parameters: @@ -1151,59 +1290,40 @@ paths: 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}/allCustomFields: - get: - tags: - - "Account" - summary: "Retrieve account customFields" - description: "" - operationId: "getAllCustomFields" - produces: - - "application/json" - parameters: - - name: "accountId" - in: "path" - required: true + - name: "startDate" + in: "query" + required: false type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "objectType" + format: "date" + - name: "endDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "withMigrationInvoices" + in: "query" + required: false + type: "boolean" + default: false + - name: "unpaidInvoicesOnly" + in: "query" + required: false + type: "boolean" + default: false + - name: "includeVoidedInvoices" + in: "query" + required: false + type: "boolean" + default: false + - name: "includeInvoiceComponents" + in: "query" + required: false + type: "boolean" + default: false + - name: "invoicesFilter" in: "query" required: false type: "string" - 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 @@ -1219,7 +1339,7 @@ paths: schema: type: "array" items: - $ref: "#/definitions/CustomField" + $ref: "#/definitions/Invoice" "400": description: "Invalid account id supplied" "404": @@ -1228,13 +1348,13 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/timeline: + /1.0/kb/accounts/{accountId}/paymentMethods: get: tags: - "Account" - summary: "Retrieve account timeline" + summary: "Retrieve account payment methods" description: "" - operationId: "getAccountTimeline" + operationId: "getPaymentMethodsForAccount" produces: - "application/json" parameters: @@ -1244,11 +1364,23 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "parallel" + - name: "withPluginInfo" in: "query" required: false type: "boolean" default: false + - name: "includedDeleted" + in: "query" + required: false + type: "boolean" + default: false + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" - name: "audit" in: "query" required: false @@ -1262,7 +1394,9 @@ paths: "200": description: "successful operation" schema: - $ref: "#/definitions/AccountTimeline" + type: "array" + items: + $ref: "#/definitions/PaymentMethod" "400": description: "Invalid account id supplied" "404": @@ -1271,13 +1405,14 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/allTags: - get: + post: tags: - "Account" - summary: "Retrieve account tags" + summary: "Add a payment method" description: "" - operationId: "getAllTags" + operationId: "createPaymentMethod" + consumes: + - "application/json" produces: - "application/json" parameters: @@ -1287,35 +1422,88 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "objectType" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/PaymentMethod" + - name: "isDefault" in: "query" required: false - type: "string" - enum: - - "ACCOUNT" - - "ACCOUNT_EMAIL" - - "BLOCKING_STATES" - - "BUNDLE" - - "CUSTOM_FIELD" - - "INVOICE" - - "PAYMENT" - - "TRANSACTION" - - "INVOICE_ITEM" - - "INVOICE_PAYMENT" - - "SUBSCRIPTION" - - "SUBSCRIPTION_EVENT" - - "SERVICE_BROADCAST" - - "PAYMENT_ATTEMPT" - - "PAYMENT_METHOD" - - "TAG" - - "TAG_DEFINITION" - - "TENANT" - - "TENANT_KVS" - - name: "includedDeleted" + type: "boolean" + default: false + - name: "payAllUnpaidInvoices" in: "query" required: false type: "boolean" default: false + - name: "controlPluginName" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "201": + description: "Payment method created" + schema: + $ref: "#/definitions/PaymentMethod" + "400": + description: "Invalid account id supplied" + "404": + description: "Account not found" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/accounts/{accountId}/bundles/pagination: + get: + tags: + - "Account" + summary: "Retrieve paginated bundles for account" + description: "" + operationId: "getAccountBundlesPaginated" + produces: + - "application/json" + parameters: + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "offset" + in: "query" + required: false + type: "integer" + default: 0 + format: "int64" + - name: "limit" + in: "query" + required: false + type: "integer" + default: 100 + format: "int64" - name: "audit" in: "query" required: false @@ -1331,7 +1519,7 @@ paths: schema: type: "array" items: - $ref: "#/definitions/Tag" + $ref: "#/definitions/Bundle" "400": description: "Invalid account id supplied" "404": @@ -1340,13 +1528,13 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/emails: + /1.0/kb/accounts/{accountId}/auditLogsWithHistory: get: tags: - "Account" - summary: "Retrieve an account emails" + summary: "Retrieve account audit logs with history by account id" description: "" - operationId: "getEmails" + operationId: "getAccountAuditLogsWithHistory" produces: - "application/json" parameters: @@ -1362,19 +1550,20 @@ paths: schema: type: "array" items: - $ref: "#/definitions/AccountEmail" - "400": - description: "Invalid account id supplied" + $ref: "#/definitions/AuditLog" + "404": + description: "Account not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - post: + /1.0/kb/accounts/{accountId}/cbaRebalancing: + put: tags: - "Account" - summary: "Add account email" + summary: "Rebalance account CBA" description: "" - operationId: "addEmail" + operationId: "rebalanceExistingCBAOnAccount" consumes: - "application/json" produces: @@ -1386,11 +1575,6 @@ 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 @@ -1404,44 +1588,47 @@ paths: required: false type: "string" responses: - "201": - description: "Email created successfully" - schema: - type: "array" - items: - $ref: "#/definitions/AccountEmail" + "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: + /1.0/kb/accounts/{accountId}/payments: get: tags: - "Account" - summary: "Retrieve an account by external key" + summary: "Retrieve account payments" description: "" - operationId: "getAccountByKey" + operationId: "getPaymentsForAccount" produces: - "application/json" parameters: - - name: "externalKey" - in: "query" + - name: "accountId" + in: "path" required: true type: "string" - - name: "accountWithBalance" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "withAttempts" in: "query" required: false type: "boolean" default: false - - name: "accountWithBalanceAndCBA" + - 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 @@ -1455,9 +1642,11 @@ paths: "200": description: "successful operation" schema: - $ref: "#/definitions/Account" - "404": - description: "Account not found" + type: "array" + items: + $ref: "#/definitions/Payment" + "400": + description: "Invalid account id supplied" security: - basicAuth: [] - Killbill Api Key: [] @@ -1465,19 +1654,44 @@ paths: post: tags: - "Account" - summary: "Create account" + summary: "Trigger a payment (authorization, purchase or credit)" description: "" - operationId: "createAccount" + operationId: "processPayment" 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" + $ref: "#/definitions/PaymentTransaction" + - name: "paymentMethodId" + in: "query" + required: false + type: "string" + format: "uuid" + - name: "controlPluginName" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -1492,47 +1706,51 @@ paths: type: "string" responses: "201": - description: "Account created successfully" + description: "Payment transaction created successfully" schema: - $ref: "#/definitions/Account" + $ref: "#/definitions/Payment" "400": - description: "Invalid account data 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/pagination: + /1.0/kb/accounts/{accountId}/bundles: get: tags: - "Account" - summary: "List accounts" + summary: "Retrieve bundles for account" description: "" - operationId: "getAccounts" + operationId: "getAccountBundles" 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" + - name: "accountId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - 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 @@ -1548,48 +1766,55 @@ paths: schema: type: "array" items: - $ref: "#/definitions/Account" + $ref: "#/definitions/Bundle" + "400": + description: "Invalid account id supplied" + "404": + description: "Account not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/search/{searchKey}: + /1.0/kb/accounts/{accountId}/allCustomFields: get: tags: - "Account" - summary: "Search accounts" + summary: "Retrieve account customFields" description: "" - operationId: "searchAccounts" + operationId: "getAllCustomFields" 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" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "objectType" 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 + 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 @@ -1605,18 +1830,22 @@ paths: schema: type: "array" items: - $ref: "#/definitions/Account" + $ref: "#/definitions/CustomField" + "400": + description: "Invalid account id supplied" + "404": + description: "Account not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/emails/{email}: - delete: + /1.0/kb/accounts/{accountId}/overdue: + get: tags: - "Account" - summary: "Delete email from account" + summary: "Retrieve overdue state for account" description: "" - operationId: "removeEmail" + operationId: "getOverdueAccount" produces: - "application/json" parameters: @@ -1626,38 +1855,26 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "email" - in: "path" - required: true - type: "string" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: - "204": - description: "Successful operation" + "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}/auditLogsWithHistory: + /1.0/kb/accounts/{accountId}/invoicePayments: get: tags: - "Account" - summary: "Retrieve account audit logs with history by account id" + summary: "Retrieve account invoice payments" description: "" - operationId: "getAccountAuditLogsWithHistory" + operationId: "getInvoicePayments" produces: - "application/json" parameters: @@ -1667,26 +1884,55 @@ 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/AuditLog" + $ref: "#/definitions/InvoicePayment" + "400": + description: "Invalid account id supplied" "404": description: "Account not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/invoices: - get: + post: tags: - "Account" - summary: "Retrieve account invoices" + summary: "Trigger a payment for all unpaid invoices" description: "" - operationId: "getInvoicesForAccount" + operationId: "payAllInvoices" + consumes: + - "application/json" produces: - "application/json" parameters: @@ -1696,71 +1942,66 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "startDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "endDate" + - name: "paymentMethodId" in: "query" required: false type: "string" - format: "date" - - name: "withMigrationInvoices" + format: "uuid" + - name: "externalPayment" in: "query" required: false type: "boolean" default: false - - name: "unpaidInvoicesOnly" + - name: "paymentAmount" in: "query" required: false - type: "boolean" - default: false - - name: "includeVoidedInvoices" + type: "number" + - name: "targetDate" in: "query" required: false - type: "boolean" - default: false - - name: "includeInvoiceComponents" + type: "string" + format: "date" + - name: "pluginProperty" in: "query" required: false - type: "boolean" - default: false - - name: "invoicesFilter" - 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: "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: "Successful operation" schema: type: "array" items: $ref: "#/definitions/Invoice" - "400": - description: "Invalid account id supplied" + "204": + description: "Nothing to pay" "404": - description: "Account not found" + description: "Invalid account id supplied" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/invoices/pagination: + /1.0/kb/accounts/{accountId}/timeline: get: tags: - "Account" - summary: "Retrieve paginated invoices for account" + summary: "Retrieve account timeline" description: "" - operationId: "getInvoicesForAccountPaginated" + operationId: "getAccountTimeline" produces: - "application/json" parameters: @@ -1770,18 +2011,11 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "offset" - in: "query" - required: false - type: "integer" - default: 0 - format: "int64" - - name: "limit" + - name: "parallel" in: "query" required: false - type: "integer" - default: 100 - format: "int64" + type: "boolean" + default: false - name: "audit" in: "query" required: false @@ -1795,9 +2029,7 @@ paths: "200": description: "successful operation" schema: - type: "array" - items: - $ref: "#/definitions/Invoice" + $ref: "#/definitions/AccountTimeline" "400": description: "Invalid account id supplied" "404": @@ -1806,13 +2038,13 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/paymentMethods: + /1.0/kb/accounts/{accountId}/allTags: get: tags: - "Account" - summary: "Retrieve account payment methods" + summary: "Retrieve account tags" description: "" - operationId: "getPaymentMethodsForAccount" + operationId: "getAllTags" produces: - "application/json" parameters: @@ -1822,23 +2054,35 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "withPluginInfo" + - name: "objectType" in: "query" required: false - type: "boolean" - default: false + type: "string" + enum: + - "ACCOUNT" + - "ACCOUNT_EMAIL" + - "BLOCKING_STATES" + - "BUNDLE" + - "CUSTOM_FIELD" + - "INVOICE" + - "PAYMENT" + - "TRANSACTION" + - "INVOICE_ITEM" + - "INVOICE_PAYMENT" + - "SUBSCRIPTION" + - "SUBSCRIPTION_EVENT" + - "SERVICE_BROADCAST" + - "PAYMENT_ATTEMPT" + - "PAYMENT_METHOD" + - "TAG" + - "TAG_DEFINITION" + - "TENANT" + - "TENANT_KVS" - name: "includedDeleted" in: "query" required: false type: "boolean" default: false - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: - type: "string" - collectionFormat: "multi" - name: "audit" in: "query" required: false @@ -1854,7 +2098,7 @@ paths: schema: type: "array" items: - $ref: "#/definitions/PaymentMethod" + $ref: "#/definitions/Tag" "400": description: "Invalid account id supplied" "404": @@ -1863,14 +2107,13 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - post: + /1.0/kb/accounts/{accountId}/auditLogs: + get: tags: - "Account" - summary: "Add a payment method" + summary: "Retrieve audit logs by account id" description: "" - operationId: "createPaymentMethod" - consumes: - - "application/json" + operationId: "getAccountAuditLogs" produces: - "application/json" parameters: @@ -1880,67 +2123,26 @@ 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" - 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 method created" + "200": + description: "successful operation" schema: - $ref: "#/definitions/PaymentMethod" - "400": - description: "Invalid account id supplied" + type: "array" + items: + $ref: "#/definitions/AuditLog" "404": description: "Account not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/bundles/pagination: + /1.0/kb/accounts/{accountId}/children: get: tags: - "Account" - summary: "Retrieve paginated bundles for account" + summary: "List children accounts" description: "" - operationId: "getAccountBundlesPaginated" + operationId: "getChildrenAccounts" produces: - "application/json" parameters: @@ -1950,18 +2152,16 @@ paths: 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 @@ -1977,94 +2177,72 @@ paths: schema: type: "array" items: - $ref: "#/definitions/Bundle" + $ref: "#/definitions/Account" "400": - description: "Invalid account id supplied" + description: "Invalid parent account id supplied" "404": - description: "Account not found" + description: "Parent Account not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/paymentMethods/{paymentMethodId}/setDefault: + /1.0/kb/admin/healthcheck: put: tags: - - "Account" - summary: "Set the default payment method" + - "Admin" + summary: "Put the host back into rotation" description: "" - operationId: "setDefaultPaymentMethod" - consumes: + 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: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "paymentMethodId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "payAllUnpaidInvoices" - in: "query" - required: false - type: "boolean" - default: false - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: - 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" + parameters: [] responses: "204": description: "Successful operation" - "400": - description: "Invalid account id or payment method id supplied" - "404": - description: "Account not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/paymentMethods/refresh: - put: + /1.0/kb/admin/invoices: + post: tags: - - "Account" - summary: "Refresh account payment methods" + - "Admin" + summary: "Trigger an invoice generation for all parked accounts" description: "" - operationId: "refreshPaymentMethods" + operationId: "triggerInvoiceGenerationForParkedAccounts" + consumes: + - "application/json" produces: - "application/json" parameters: - - name: "accountId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "pluginName" + - name: "offset" in: "query" required: false - type: "string" + type: "integer" + default: 0 + format: "int64" + - name: "limit" + in: "query" + required: false + type: "integer" + default: 100 + format: "int64" - name: "pluginProperty" in: "query" required: false @@ -2084,24 +2262,37 @@ paths: in: "header" required: false type: "string" + responses: + "200": + description: "Successful operation" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/admin/cache/tenants: + delete: + tags: + - "Admin" + summary: "Invalidates Caches per tenant level" + description: "" + operationId: "invalidatesCacheByTenant" + produces: + - "application/json" + parameters: [] responses: "204": description: "Successful operation" - "400": - description: "Invalid account id supplied" - "404": - description: "Account not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{accountId}/children: - get: + /1.0/kb/admin/cache/accounts/{accountId}: + delete: tags: - - "Account" - summary: "List children accounts" + - "Admin" + summary: "Invalidates Caches per account level" description: "" - operationId: "getChildrenAccounts" + operationId: "invalidatesCacheByAccount" produces: - "application/json" parameters: @@ -2111,58 +2302,44 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "accountWithBalance" - in: "query" - required: false - type: "boolean" - default: false - - name: "accountWithBalanceAndCBA" - in: "query" - required: false - type: "boolean" - default: false - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" responses: - "200": - description: "successful operation" - schema: - type: "array" - items: - $ref: "#/definitions/Account" + "204": + description: "Successful operation" "400": - description: "Invalid parent account id supplied" - "404": - description: "Parent Account not found" + description: "Invalid account id supplied" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/accounts/{childAccountId}/transferCredit: + /1.0/kb/admin/payments/{paymentId}/transactions/{paymentTransactionId}: put: tags: - - "Account" - summary: "Move a given child credit to the parent level" + - "Admin" + summary: "Update existing paymentTransaction and associated payment state" description: "" - operationId: "transferChildCreditToParent" + operationId: "updatePaymentTransactionState" consumes: - "application/json" produces: - "application/json" parameters: - - name: "childAccountId" + - 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 @@ -2179,92 +2356,31 @@ paths: "204": description: "Successful operation" "400": - description: "Account does not have credit" - "404": - description: "Account not found" + description: "Invalid account data supplied" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/admin/invoices: - post: + /1.0/kb/admin/cache: + delete: tags: - "Admin" - summary: "Trigger an invoice generation for all parked accounts" + summary: "Invalidates the given Cache if specified, otherwise invalidates all\ + \ caches" description: "" - operationId: "triggerInvoiceGenerationForParkedAccounts" - consumes: - - "application/json" + operationId: "invalidatesCache" 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" + - name: "cacheName" in: "query" required: false - type: "array" - items: - type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false type: "string" - responses: - "200": - description: "Successful operation" - 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: "Cache name does not exist or is not alive" security: - basicAuth: [] - Killbill Api Key: [] @@ -2331,91 +2447,56 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/admin/cache: - delete: - tags: - - "Admin" - summary: "Invalidates the given Cache if specified, otherwise invalidates all\ - \ caches" - description: "" - operationId: "invalidatesCache" - produces: - - "application/json" - parameters: - - name: "cacheName" - in: "query" - required: false - type: "string" - responses: - "204": - description: "Successful operation" - "400": - description: "Cache name does not exist or is not alive" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/admin/cache/accounts/{accountId}: - delete: + /1.0/kb/bundles/{bundleId}: + get: tags: - - "Admin" - summary: "Invalidates Caches per account level" + - "Bundle" + summary: "Retrieve a bundle by id" description: "" - operationId: "invalidatesCacheByAccount" + operationId: "getBundle" produces: - "application/json" parameters: - - name: "accountId" + - name: "bundleId" in: "path" required: true type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: - "204": - description: "Successful operation" + "200": + description: "successful operation" + schema: + $ref: "#/definitions/Bundle" "400": - description: "Invalid account id supplied" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/admin/cache/tenants: - delete: - tags: - - "Admin" - summary: "Invalidates Caches per tenant level" - description: "" - operationId: "invalidatesCacheByTenant" - produces: - - "application/json" - parameters: [] - responses: - "204": - description: "Successful operation" + description: "Invalid bundle id supplied" + "404": + description: "Bundle not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/admin/payments/{paymentId}/transactions/{paymentTransactionId}: - put: + post: tags: - - "Admin" - summary: "Update existing paymentTransaction and associated payment state" + - "Bundle" + summary: "Transfer a bundle to another account" description: "" - operationId: "updatePaymentTransactionState" + operationId: "transferBundle" consumes: - "application/json" produces: - "application/json" parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "paymentTransactionId" + - name: "bundleId" in: "path" required: true type: "string" @@ -2425,7 +2506,38 @@ paths: name: "body" required: true schema: - $ref: "#/definitions/AdminPayment" + $ref: "#/definitions/Bundle" + - name: "requestedDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "billingPolicy" + in: "query" + required: false + type: "string" + default: "END_OF_TERM" + enum: + - "START_OF_TERM" + - "END_OF_TERM" + - "IMMEDIATE" + - "ILLEGAL" + - name: "bcdTransfer" + in: "query" + required: false + type: "string" + default: "USE_EXISTING" + enum: + - "NONE" + - "USE_EXISTING" + - "ALIGN_WITH_EFF_DT" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -2439,10 +2551,14 @@ paths: required: false type: "string" responses: - "204": - description: "Successful operation" + "201": + description: "Bundle transferred successfully" + schema: + $ref: "#/definitions/Bundle" "400": - description: "Invalid account data supplied" + description: "Invalid bundle id, requested date or policy supplied" + "404": + description: "Bundle not found" security: - basicAuth: [] - Killbill Api Key: [] @@ -2766,13 +2882,13 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/bundles/{bundleId}/renameKey: - put: + /1.0/kb/bundles/{bundleId}/block: + post: tags: - "Bundle" - summary: "Update a bundle externalKey" + summary: "Block a bundle" description: "" - operationId: "renameExternalKey" + operationId: "addBundleBlockingState" consumes: - "application/json" parameters: @@ -2786,7 +2902,19 @@ paths: name: "body" required: true schema: - $ref: "#/definitions/Bundle" + $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 @@ -2800,73 +2928,71 @@ paths: required: false type: "string" responses: - "204": - description: "Successful operation" + "201": + description: "Blocking state created successfully" + schema: + type: "array" + items: + $ref: "#/definitions/BlockingState" "400": - description: "Invalid argumnent supplied" + description: "Invalid bundle id supplied" "404": description: "Bundle not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/bundles: + /1.0/kb/bundles/{bundleId}/auditLogsWithHistory: get: tags: - "Bundle" - summary: "Retrieve a bundle by external key" + summary: "Retrieve bundle audit logs with history by id" description: "" - operationId: "getBundleByKey" + operationId: "getBundleAuditLogsWithHistory" produces: - "application/json" parameters: - - name: "externalKey" - in: "query" + - name: "bundleId" + in: "path" required: true type: "string" - - name: "includedDeleted" - in: "query" - required: false - type: "boolean" - default: false - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" responses: "200": description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/Bundle" + $ref: "#/definitions/AuditLog" "404": - description: "Bundle not found" + description: "Subscription bundle not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/bundles/{bundleId}: + /1.0/kb/bundles/pagination: get: tags: - "Bundle" - summary: "Retrieve a bundle by id" + summary: "List bundles" description: "" - operationId: "getBundle" + operationId: "getBundles" produces: - "application/json" parameters: - - name: "bundleId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" + - name: "offset" + in: "query" + required: false + type: "integer" + default: 0 + format: "int64" + - name: "limit" + in: "query" + required: false + type: "integer" + default: 100 + format: "int64" - name: "audit" in: "query" required: false @@ -2880,103 +3006,69 @@ paths: "200": description: "successful operation" schema: - $ref: "#/definitions/Bundle" - "400": - description: "Invalid bundle id supplied" - "404": - description: "Bundle not found" + type: "array" + items: + $ref: "#/definitions/Bundle" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - post: + /1.0/kb/bundles: + get: tags: - "Bundle" - summary: "Transfer a bundle to another account" + summary: "Retrieve a bundle by external key" description: "" - operationId: "transferBundle" - consumes: - - "application/json" + operationId: "getBundleByKey" 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: "requestedDate" + - name: "externalKey" in: "query" - required: false + required: true type: "string" - format: "date" - - name: "billingPolicy" + - name: "includedDeleted" in: "query" required: false - type: "string" - default: "END_OF_TERM" - enum: - - "START_OF_TERM" - - "END_OF_TERM" - - "IMMEDIATE" - - "ILLEGAL" - - name: "bcdTransfer" + type: "boolean" + default: false + - name: "audit" in: "query" required: false type: "string" - default: "USE_EXISTING" + default: "NONE" enum: + - "FULL" + - "MINIMAL" - "NONE" - - "USE_EXISTING" - - "ALIGN_WITH_EFF_DT" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: - type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" responses: - "201": - description: "Bundle transferred successfully" + "200": + description: "successful operation" schema: - $ref: "#/definitions/Bundle" - "400": - description: "Invalid bundle id, requested date or policy supplied" + type: "array" + items: + $ref: "#/definitions/Bundle" "404": description: "Bundle not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/bundles/pagination: + /1.0/kb/bundles/search/{searchKey}: get: tags: - "Bundle" - summary: "List bundles" + summary: "Search bundles" description: "" - operationId: "getBundles" + operationId: "searchBundles" produces: - "application/json" parameters: + - name: "searchKey" + in: "path" + required: true + type: "string" + pattern: ".*" - name: "offset" in: "query" required: false @@ -3062,49 +3154,46 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/bundles/search/{searchKey}: - get: + /1.0/kb/bundles/{bundleId}/renameKey: + put: tags: - "Bundle" - summary: "Search bundles" + summary: "Update a bundle externalKey" description: "" - operationId: "searchBundles" - produces: + operationId: "renameExternalKey" + consumes: - "application/json" parameters: - - name: "searchKey" + - name: "bundleId" in: "path" required: true type: "string" - pattern: ".*" - - name: "offset" - in: "query" - required: false - type: "integer" - default: 0 - format: "int64" - - name: "limit" - in: "query" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/Bundle" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" required: false - type: "integer" - default: 100 - format: "int64" - - 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/Bundle" + "204": + description: "Successful operation" + "400": + description: "Invalid argumnent supplied" + "404": + description: "Bundle not found" security: - basicAuth: [] - Killbill Api Key: [] @@ -3162,128 +3251,100 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/bundles/{bundleId}/auditLogsWithHistory: + /1.0/kb/catalog/priceList: get: tags: - - "Bundle" - summary: "Retrieve bundle audit logs with history by id" + - "Catalog" + summary: "Retrieve priceList for a given subscription and date" description: "" - operationId: "getBundleAuditLogsWithHistory" + operationId: "getPriceListForSubscriptionAndDate" produces: - "application/json" parameters: - - name: "bundleId" - in: "path" - required: true + - name: "subscriptionId" + in: "query" + required: false type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" + - name: "requestedDate" + in: "query" + required: false + type: "string" + format: "date" responses: "200": description: "successful operation" schema: - type: "array" - items: - $ref: "#/definitions/AuditLog" - "404": - description: "Subscription bundle not found" + $ref: "#/definitions/PriceList" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/bundles/{bundleId}/block: - post: + /1.0/kb/catalog/product: + get: tags: - - "Bundle" - summary: "Block a bundle" + - "Catalog" + summary: "Retrieve product for a given subscription and date" description: "" - operationId: "addBundleBlockingState" - consumes: + operationId: "getProductForSubscriptionAndDate" + produces: - "application/json" parameters: - - name: "bundleId" - in: "path" - required: true + - name: "subscriptionId" + in: "query" + required: false type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/BlockingState" - name: "requestedDate" in: "query" required: false type: "string" format: "date" - - name: "pluginProperty" + responses: + "200": + description: "successful operation" + schema: + $ref: "#/definitions/Product" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/catalog/phase: + get: + tags: + - "Catalog" + summary: "Retrieve phase for a given subscription and date" + description: "" + operationId: "getPhaseForSubscriptionAndDate" + produces: + - "application/json" + parameters: + - name: "subscriptionId" 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: "Blocking state created successfully" - schema: - 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/availableBasePlans: - get: - tags: - - "Catalog" - summary: "Retrieve available base plans" - description: "" - operationId: "getAvailableBasePlans" - produces: - - "application/json" - parameters: - - 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/Phase" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/catalog/priceList: + /1.0/kb/catalog/plan: get: tags: - "Catalog" - summary: "Retrieve priceList for a given subscription and date" + summary: "Retrieve plan for a given subscription and date" description: "" - operationId: "getPriceListForSubscriptionAndDate" + operationId: "getPlanForSubscriptionAndDate" produces: - "application/json" parameters: @@ -3301,107 +3362,110 @@ paths: "200": description: "successful operation" schema: - $ref: "#/definitions/PriceList" + $ref: "#/definitions/Plan" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/catalog/product: + /1.0/kb/catalog/availableBasePlans: get: tags: - "Catalog" - summary: "Retrieve product for a given subscription and date" + summary: "Retrieve available base plans" description: "" - operationId: "getProductForSubscriptionAndDate" + operationId: "getAvailableBasePlans" produces: - "application/json" parameters: - - name: "subscriptionId" + - name: "accountId" in: "query" required: false type: "string" format: "uuid" - - name: "requestedDate" - in: "query" - required: false - type: "string" - format: "date" responses: "200": description: "successful operation" schema: - $ref: "#/definitions/Product" + type: "array" + items: + $ref: "#/definitions/PlanDetail" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/catalog/plan: + /1.0/kb/catalog/xml: get: tags: - "Catalog" - summary: "Retrieve plan for a given subscription and date" + summary: "Retrieve the full catalog as XML" description: "" - operationId: "getPlanForSubscriptionAndDate" + 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/Plan" + type: "string" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/catalog/phase: - get: + post: tags: - "Catalog" - summary: "Retrieve phase for a given subscription and date" + summary: "Upload the full catalog as XML" description: "" - operationId: "getPhaseForSubscriptionAndDate" - 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/Phase" + type: "string" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/catalog/simplePlan: + /1.0/kb/catalog/xml/validate: post: tags: - "Catalog" - summary: "Add a simple plan entry in the current version of the catalog" + summary: "Validate a XML catalog" description: "" - operationId: "addSimplePlan" + operationId: "validateCatalogXml" consumes: - - "application/json" + - "text/xml" produces: - "application/json" parameters: @@ -3409,7 +3473,7 @@ paths: name: "body" required: true schema: - $ref: "#/definitions/SimplePlan" + type: "string" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -3423,10 +3487,10 @@ paths: required: false type: "string" responses: - "201": - description: "Created new plan successfully" + "200": + description: "successful operation" schema: - type: "string" + $ref: "#/definitions/CatalogValidation" security: - basicAuth: [] - Killbill Api Key: [] @@ -3488,21 +3552,24 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/catalog/xml: + /1.0/kb/catalog/availableAddons: get: tags: - "Catalog" - summary: "Retrieve the full catalog as XML" + summary: "Retrieve available add-ons for a given product" description: "" - operationId: "getCatalogXml" + operationId: "getAvailableAddons" produces: - - "text/xml" + - "application/json" parameters: - - name: "requestedDate" + - name: "baseProductName" + in: "query" + required: false + type: "string" + - name: "priceListName" in: "query" required: false type: "string" - format: "date-time" - name: "accountId" in: "query" required: false @@ -3512,25 +3579,57 @@ paths: "200": description: "successful operation" schema: - type: "string" + 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/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 @@ -3545,22 +3644,22 @@ 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/xml/validate: + /1.0/kb/credits: post: tags: - - "Catalog" - summary: "Validate a XML catalog" + - "Credit" + summary: "Create a credit" description: "" - operationId: "validateCatalogXml" + operationId: "createCredits" consumes: - - "text/xml" + - "application/json" produces: - "application/json" parameters: @@ -3568,7 +3667,26 @@ paths: name: "body" required: true schema: + type: "array" + items: + $ref: "#/definitions/InvoiceItem" + - name: "requestedDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "autoCommit" + in: "query" + required: false + type: "boolean" + default: false + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: type: "string" + collectionFormat: "multi" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -3582,88 +3700,33 @@ paths: required: false type: "string" responses: - "200": - description: "successful operation" + "201": + description: "Created credit successfully" schema: - $ref: "#/definitions/CatalogValidation" + type: "array" + items: + $ref: "#/definitions/InvoiceItem" + "400": + description: "Invalid account id supplied" + "404": + description: "Account not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/catalog/availableAddons: + /1.0/kb/credits/{creditId}: get: tags: - - "Catalog" - summary: "Retrieve available add-ons for a given product" + - "Credit" + summary: "Retrieve a credit by id" description: "" - operationId: "getAvailableAddons" + operationId: "getCredit" 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 + - name: "creditId" + in: "path" + required: true type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" @@ -3680,69 +3743,6 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/credits: - post: - tags: - - "Credit" - summary: "Create a credit" - description: "" - operationId: "createCredits" - consumes: - - "application/json" - produces: - - "application/json" - parameters: - - in: "body" - name: "body" - required: true - schema: - type: "array" - items: - $ref: "#/definitions/InvoiceItem" - - name: "requestedDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "autoCommit" - in: "query" - required: false - type: "boolean" - default: false - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: - type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "201": - description: "Created credit successfully" - schema: - type: "array" - items: - $ref: "#/definitions/InvoiceItem" - "400": - description: "Invalid account id supplied" - "404": - description: "Account not found" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] /1.0/kb/customFields/pagination: get: tags: @@ -3785,53 +3785,6 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/customFields/search/{searchKey}: - get: - tags: - - "CustomField" - summary: "Search custom fields" - description: "" - operationId: "searchCustomFields" - produces: - - "application/json" - parameters: - - name: "searchKey" - in: "path" - required: true - type: "string" - pattern: ".*" - - name: "offset" - in: "query" - required: false - type: "integer" - default: 0 - format: "int64" - - name: "limit" - in: "query" - required: false - type: "integer" - default: 100 - format: "int64" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" - responses: - "200": - description: "successful operation" - schema: - type: "array" - items: - $ref: "#/definitions/CustomField" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] /1.0/kb/customFields/search: get: tags: @@ -3915,6 +3868,53 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] + /1.0/kb/customFields/search/{searchKey}: + get: + tags: + - "CustomField" + summary: "Search custom fields" + description: "" + operationId: "searchCustomFields" + produces: + - "application/json" + parameters: + - name: "searchKey" + in: "path" + required: true + type: "string" + pattern: ".*" + - name: "offset" + in: "query" + required: false + type: "integer" + default: 0 + format: "int64" + - name: "limit" + in: "query" + required: false + type: "integer" + default: 100 + format: "int64" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" + responses: + "200": + description: "successful operation" + schema: + type: "array" + items: + $ref: "#/definitions/CustomField" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/export/{accountId}: get: tags: @@ -4307,50 +4307,13 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoicePayments/{paymentId}/customFields: - get: - tags: - - "InvoicePayment" - summary: "Retrieve payment custom fields" - description: "" - operationId: "getInvoicePaymentCustomFields" - produces: - - "application/json" - parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" - responses: - "200": - description: "successful operation" - schema: - type: "array" - items: - $ref: "#/definitions/CustomField" - "400": - description: "Invalid payment id supplied" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] + /1.0/kb/invoicePayments/{paymentId}/chargebackReversals: post: tags: - "InvoicePayment" - summary: "Add custom fields to payment" + summary: "Record a chargebackReversal" description: "" - operationId: "createInvoicePaymentCustomFields" + operationId: "createChargebackReversal" consumes: - "application/json" produces: @@ -4366,7 +4329,99 @@ paths: name: "body" required: true schema: - type: "array" + $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 reversal 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}/customFields: + get: + tags: + - "InvoicePayment" + summary: "Retrieve payment custom fields" + description: "" + operationId: "getInvoicePaymentCustomFields" + produces: + - "application/json" + parameters: + - name: "paymentId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" + responses: + "200": + description: "successful operation" + schema: + type: "array" + items: + $ref: "#/definitions/CustomField" + "400": + description: "Invalid payment id supplied" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + post: + tags: + - "InvoicePayment" + summary: "Add custom fields to payment" + description: "" + operationId: "createInvoicePaymentCustomFields" + 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" @@ -4662,61 +4717,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}: get: tags: @@ -4841,13 +4841,13 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoicePayments/{paymentId}/chargebackReversals: + /1.0/kb/invoicePayments/{paymentId}/refunds: post: tags: - "InvoicePayment" - summary: "Record a chargebackReversal" + summary: "Refund a payment, and adjust the invoice if needed" description: "" - operationId: "createChargebackReversal" + operationId: "createRefundWithAdjustments" consumes: - "application/json" produces: @@ -4864,6 +4864,16 @@ paths: required: true schema: $ref: "#/definitions/InvoicePaymentTransaction" + - name: "externalPayment" + in: "query" + required: false + type: "boolean" + default: false + - name: "paymentMethodId" + in: "query" + required: false + type: "string" + format: "uuid" - name: "pluginProperty" in: "query" required: false @@ -4885,7 +4895,7 @@ paths: type: "string" responses: "201": - description: "Created chargeback reversal successfully" + description: "Created refund successfully" schema: $ref: "#/definitions/InvoicePayment" "400": @@ -4896,13 +4906,13 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoicePayments/{paymentId}/refunds: + /1.0/kb/invoicePayments/{paymentId}/chargebacks: post: tags: - "InvoicePayment" - summary: "Refund a payment, and adjust the invoice if needed" + summary: "Record a chargeback" description: "" - operationId: "createRefundWithAdjustments" + operationId: "createChargeback" consumes: - "application/json" produces: @@ -4919,16 +4929,6 @@ paths: required: true schema: $ref: "#/definitions/InvoicePaymentTransaction" - - name: "externalPayment" - in: "query" - required: false - type: "boolean" - default: false - - name: "paymentMethodId" - in: "query" - required: false - type: "string" - format: "uuid" - name: "pluginProperty" in: "query" required: false @@ -4950,7 +4950,7 @@ paths: type: "string" responses: "201": - description: "Created refund successfully" + description: "Created chargeback successfully" schema: $ref: "#/definitions/InvoicePayment" "400": @@ -4961,6 +4961,59 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] + /1.0/kb/invoices/migration/{accountId}: + post: + tags: + - "Invoice" + summary: "Create a migration invoice" + description: "" + operationId: "createMigrationInvoice" + 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: + $ref: "#/definitions/InvoiceItem" + - name: "targetDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "201": + description: "Created migration invoice successfully" + schema: + $ref: "#/definitions/Invoice" + "400": + description: "Invalid account id or target datetime supplied" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/invoices/{invoiceId}/customFields: get: tags: @@ -5139,13 +5192,13 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoices/{invoiceId}/commitInvoice: + /1.0/kb/invoices/{invoiceId}/voidInvoice: put: tags: - "Invoice" - summary: "Perform the invoice status transition from DRAFT to COMMITTED" + summary: "Perform the action of voiding an invoice" description: "" - operationId: "commitInvoice" + operationId: "voidInvoice" consumes: - "application/json" produces: @@ -5172,19 +5225,21 @@ paths: 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/{invoiceId}/voidInvoice: + /1.0/kb/invoices/{invoiceId}/commitInvoice: put: tags: - "Invoice" - summary: "Perform the action of voiding an invoice" + summary: "Perform the invoice status transition from DRAFT to COMMITTED" description: "" - operationId: "voidInvoice" + operationId: "commitInvoice" consumes: - "application/json" produces: @@ -5211,8 +5266,6 @@ paths: responses: "204": description: "Successful operation" - "400": - description: "Invalid invoice id supplied" "404": description: "Invoice not found" security: @@ -5360,13 +5413,67 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoices/taxes/{accountId}: + /1.0/kb/invoices/group: post: tags: - "Invoice" - summary: "Create tax items" + summary: "Trigger an invoice generation" description: "" - operationId: "createTaxItems" + operationId: "createFutureInvoiceGroup" + consumes: + - "application/json" + produces: + - "application/json" + parameters: + - name: "accountId" + in: "query" + required: true + type: "string" + format: "uuid" + - name: "targetDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "201": + description: "Created invoice successfully" + schema: + 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/charges/{accountId}: + post: + tags: + - "Invoice" + summary: "Create external charge(s)" + description: "" + operationId: "createExternalCharges" consumes: - "application/json" produces: @@ -5385,16 +5492,16 @@ paths: 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: "autoCommit" + in: "query" + required: false + type: "boolean" + default: false - name: "pluginProperty" in: "query" required: false @@ -5416,7 +5523,7 @@ paths: type: "string" responses: "201": - description: "Create tax items successfully" + description: "Created external charge Successfully" schema: type: "array" items: @@ -5429,13 +5536,13 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoices/{invoiceId}: + /1.0/kb/invoices/{invoiceId}/payments: get: tags: - "Invoice" - summary: "Retrieve an invoice by id" + summary: "Retrieve payments associated with an invoice" description: "" - operationId: "getInvoice" + operationId: "getPaymentsForInvoice" produces: - "application/json" parameters: @@ -5445,7 +5552,12 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "withChildrenItems" + - name: "withPluginInfo" + in: "query" + required: false + type: "boolean" + default: false + - name: "withAttempts" in: "query" required: false type: "boolean" @@ -5463,7 +5575,9 @@ paths: "200": description: "successful operation" schema: - $ref: "#/definitions/Invoice" + type: "array" + items: + $ref: "#/definitions/InvoicePayment" "400": description: "Invalid invoice id supplied" "404": @@ -5475,9 +5589,9 @@ paths: post: tags: - "Invoice" - summary: "Adjust an invoice item" + summary: "Trigger a payment for invoice" description: "" - operationId: "adjustInvoiceItem" + operationId: "createInstantPayment" consumes: - "application/json" produces: @@ -5493,12 +5607,19 @@ paths: name: "body" required: true schema: - $ref: "#/definitions/InvoiceItem" - - name: "requestedDate" + $ref: "#/definitions/InvoicePayment" + - name: "externalPayment" in: "query" required: false - type: "string" - format: "date" + type: "boolean" + default: false + - name: "controlPluginName" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" - name: "pluginProperty" in: "query" required: false @@ -5520,69 +5641,53 @@ paths: type: "string" responses: "201": - description: "Created adjustment Successfully" + description: "Created payment Successfully" schema: - $ref: "#/definitions/Invoice" + $ref: "#/definitions/InvoicePayment" + "204": + description: "Nothing to pay for" "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/template: - get: - tags: - - "Invoice" - summary: "Retrieves the invoice template for the tenant" - description: "" - operationId: "getInvoiceTemplate" - produces: - - "text/html" - parameters: - - name: "templateWithBrandInfo" - in: "query" - required: false - type: "boolean" - default: false - responses: - "200": - description: "successful operation" - schema: - type: "string" + description: "Invalid account id or invoice id supplied" "404": - description: "Template not found" + description: "Account not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] + /1.0/kb/invoices/dryRun: post: tags: - "Invoice" - summary: "Upload the invoice template for the tenant" + summary: "Generate a dryRun invoice" description: "" - operationId: "uploadInvoiceTemplate" + operationId: "generateDryRunInvoice" consumes: - - "text/html" + - "application/json" produces: - - "text/html" + - "application/json" parameters: - 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 - - name: "templateWithBrandInfo" + type: "string" + format: "date" + - 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 @@ -5596,289 +5701,177 @@ paths: required: false type: "string" responses: - "201": - description: "Uploaded invoice template 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/byItemId/{itemId}: + /1.0/kb/invoices/{invoiceId}/auditLogsWithHistory: get: tags: - "Invoice" - summary: "Retrieve an invoice by invoice item id" + summary: "Retrieve invoice audit logs with history by id" description: "" - operationId: "getInvoiceByItemId" + operationId: "getInvoiceAuditLogsWithHistory" produces: - "application/json" parameters: - - name: "itemId" + - name: "invoiceId" in: "path" required: true type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "withChildrenItems" - in: "query" - required: false - type: "boolean" - default: false - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" responses: "200": description: "successful operation" schema: - $ref: "#/definitions/Invoice" + type: "array" + items: + $ref: "#/definitions/AuditLog" "404": description: "Invoice not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoices/{groupId}/group: + /1.0/kb/invoices/catalogTranslation/{locale}: get: tags: - "Invoice" - summary: "Retrieve a set of invoices by group id" + summary: "Retrieves the catalog translation for the tenant" description: "" - operationId: "getInvoicesGroup" + operationId: "getCatalogTranslation" produces: - - "application/json" + - "text/plain" parameters: - - name: "groupId" + - name: "locale" 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" + pattern: ".*" responses: "200": description: "successful operation" schema: - type: "array" - items: - $ref: "#/definitions/Invoice" + type: "string" "400": - description: "Invalid group id supplied" + description: "Invalid locale supplied" + "404": + description: "Template not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoices/{invoiceId}/html: - get: + post: tags: - "Invoice" - summary: "Render an invoice as HTML" + summary: "Upload the catalog translation for the tenant" description: "" - operationId: "getInvoiceAsHTML" + operationId: "uploadCatalogTranslation" + consumes: + - "text/plain" produces: - - "text/html" + - "text/plain" parameters: - - name: "invoiceId" + - name: "locale" in: "path" required: true type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - responses: - "200": - description: "successful operation" - schema: - type: "string" - "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" + pattern: ".*" + - in: "body" + name: "body" + required: true + schema: + type: "string" + - name: "deleteIfExists" in: "query" required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" - responses: - "200": - description: "successful operation" - schema: - type: "array" - items: - $ref: "#/definitions/Invoice" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/invoices/search/{searchKey}: - get: - tags: - - "Invoice" - summary: "Search invoices" - description: "" - operationId: "searchInvoices" - produces: - - "application/json" - parameters: - - name: "searchKey" - in: "path" + type: "boolean" + default: false + - name: "X-Killbill-CreatedBy" + in: "header" required: true type: "string" - pattern: ".*" - - name: "offset" - in: "query" - required: false - type: "integer" - default: 0 - format: "int64" - - name: "limit" - in: "query" + - name: "X-Killbill-Reason" + in: "header" required: false - type: "integer" - default: 100 - format: "int64" - - 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" + "201": + description: "Uploaded catalog translation Successfully" schema: - type: "array" - items: - $ref: "#/definitions/Invoice" + type: "string" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoices/byNumber/{invoiceNumber}: + /1.0/kb/invoices/manualPayTemplate/{locale}: get: tags: - "Invoice" - summary: "Retrieve an invoice by number" + summary: "Retrieves the manualPay invoice template for the tenant" description: "" - operationId: "getInvoiceByNumber" + operationId: "getInvoiceMPTemplate" produces: - - "application/json" + - "text/html" parameters: - - name: "invoiceNumber" + - name: "locale" in: "path" required: true - type: "integer" - pattern: "[0-9]+" - format: "int32" - - name: "withChildrenItems" - in: "query" - required: false - type: "boolean" - default: false - - name: "audit" - in: "query" - required: false type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" + pattern: ".*" responses: "200": description: "successful operation" schema: - $ref: "#/definitions/Invoice" + type: "string" "404": - description: "Invoice not found" + description: "Template not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoices/{invoiceId}/{invoiceItemId}/cba: - delete: + /1.0/kb/invoices: + post: tags: - "Invoice" - summary: "Delete a CBA item" + summary: "Trigger an invoice generation" description: "" - operationId: "deleteCBA" + operationId: "createFutureInvoice" consumes: - "application/json" produces: - "application/json" parameters: - - name: "invoiceId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "invoiceItemId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - name: "accountId" in: "query" required: true type: "string" format: "uuid" + - name: "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 @@ -5892,23 +5885,23 @@ paths: required: false type: "string" responses: - "204": - description: "Successful operation" + "201": + description: "Created invoice successfully" + schema: + $ref: "#/definitions/Invoice" "400": - description: "Invalid account id, invoice id or invoice item id supplied" - "404": - description: "Account or invoice not found" + 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: @@ -5925,7 +5918,7 @@ paths: "400": description: "Invalid locale supplied" "404": - description: "Template not found" + description: "Translation not found" security: - basicAuth: [] - Killbill Api Key: [] @@ -5933,9 +5926,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: @@ -5970,104 +5963,98 @@ 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}/payments: - get: + /1.0/kb/invoices/manualPayTemplate: + post: tags: - "Invoice" - summary: "Retrieve payments associated with an invoice" + summary: "Upload the manualPay invoice template for the tenant" description: "" - operationId: "getPaymentsForInvoice" + operationId: "uploadInvoiceMPTemplate" + consumes: + - "text/html" produces: - - "application/json" + - "text/html" parameters: - - name: "invoiceId" - in: "path" + - in: "body" + name: "body" required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "withPluginInfo" + schema: + type: "string" + - name: "deleteIfExists" in: "query" required: false type: "boolean" default: false - - name: "withAttempts" - 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/InvoicePayment" - "400": - description: "Invalid invoice id supplied" - "404": - description: "Invoice not found" + type: "string" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - post: + /1.0/kb/invoices/template: + get: tags: - "Invoice" - summary: "Trigger a payment for invoice" + summary: "Retrieves the invoice template for the tenant" description: "" - operationId: "createInstantPayment" - consumes: - - "application/json" + operationId: "getInvoiceTemplate" produces: - - "application/json" + - "text/html" + parameters: [] + responses: + "200": + description: "successful operation" + schema: + type: "string" + "404": + description: "Template not found" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + post: + tags: + - "Invoice" + summary: "Upload the invoice template for the tenant" + description: "" + operationId: "uploadInvoiceTemplate" + consumes: + - "text/html" + produces: + - "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/InvoicePayment" - - name: "externalPayment" + type: "string" + - name: "deleteIfExists" in: "query" required: false type: "boolean" default: false - - name: "controlPluginName" - in: "query" - required: false - type: "array" - items: - type: "string" - collectionFormat: "multi" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: - type: "string" - collectionFormat: "multi" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -6082,37 +6069,44 @@ paths: type: "string" responses: "201": - description: "Created payment Successfully" + description: "Uploaded invoice template Successfully" schema: - $ref: "#/definitions/InvoicePayment" - "204": - description: "Nothing to pay for" - "400": - description: "Invalid account id or invoice id supplied" - "404": - description: "Account not found" + type: "string" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoices: + /1.0/kb/invoices/taxes/{accountId}: post: tags: - "Invoice" - summary: "Trigger an invoice generation" + summary: "Create tax items" description: "" - operationId: "createFutureInvoice" + operationId: "createTaxItems" consumes: - "application/json" produces: - "application/json" parameters: - name: "accountId" - in: "query" + in: "path" required: true type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "targetDate" + - 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" @@ -6138,33 +6132,85 @@ paths: type: "string" responses: "201": - description: "Created invoice successfully" + description: "Create tax items successfully" + schema: + type: "array" + items: + $ref: "#/definitions/InvoiceItem" + "400": + description: "Invalid account id supplied" + "404": + description: "Account not found" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/invoices/{invoiceId}: + get: + tags: + - "Invoice" + summary: "Retrieve an invoice by id" + description: "" + operationId: "getInvoice" + produces: + - "application/json" + parameters: + - name: "invoiceId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "withChildrenItems" + in: "query" + required: false + type: "boolean" + default: false + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" + responses: + "200": + description: "successful operation" schema: $ref: "#/definitions/Invoice" "400": - description: "Invalid account id or target datetime supplied" + description: "Invalid invoice id supplied" + "404": + description: "Invoice not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoices/group: post: tags: - "Invoice" - summary: "Trigger an invoice generation" + summary: "Adjust an invoice item" description: "" - operationId: "createFutureInvoiceGroup" + operationId: "adjustInvoiceItem" 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: "targetDate" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/InvoiceItem" + - name: "requestedDate" in: "query" required: false type: "string" @@ -6190,134 +6236,135 @@ paths: type: "string" responses: "201": - description: "Created invoice successfully" + description: "Created adjustment Successfully" schema: - type: "array" - items: - $ref: "#/definitions/Invoice" + $ref: "#/definitions/Invoice" "400": - description: "Invalid account id or target datetime supplied" + description: "Invalid account id, invoice id or invoice item id supplied" + "404": + description: "Invoice not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoices/translation/{locale}: + /1.0/kb/invoices/byItemId/{itemId}: get: tags: - "Invoice" - summary: "Retrieves the invoice translation for the tenant" + summary: "Retrieve an invoice by invoice item id" description: "" - operationId: "getInvoiceTranslation" + operationId: "getInvoiceByItemId" produces: - - "text/plain" + - "application/json" parameters: - - name: "locale" + - name: "itemId" in: "path" required: true type: "string" - pattern: ".*" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "withChildrenItems" + in: "query" + required: false + type: "boolean" + default: false + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" schema: - type: "string" - "400": - description: "Invalid locale supplied" + $ref: "#/definitions/Invoice" "404": - description: "Translation not found" + description: "Invoice not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - post: + /1.0/kb/invoices/{groupId}/group: + get: tags: - "Invoice" - summary: "Upload the invoice translation for the tenant" + summary: "Retrieve a set of invoices by group id" description: "" - operationId: "uploadInvoiceTranslation" - consumes: - - "text/plain" + operationId: "getInvoicesGroup" produces: - - "text/plain" + - "application/json" parameters: - - name: "locale" + - name: "groupId" in: "path" required: true type: "string" - pattern: ".*" - - in: "body" - name: "body" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "accountId" + in: "query" required: true - schema: - type: "string" - - name: "deleteIfExists" + type: "string" + format: "uuid" + - name: "withChildrenItems" 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" + - name: "audit" + in: "query" required: false type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: - "201": - description: "Uploaded invoice translation Successfully" + "200": + description: "successful operation" schema: - type: "string" + type: "array" + items: + $ref: "#/definitions/Invoice" + "400": + description: "Invalid group id supplied" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoices/charges/{accountId}: - post: + /1.0/kb/invoices/{invoiceId}/{invoiceItemId}/cba: + delete: tags: - "Invoice" - summary: "Create external charge(s)" + summary: "Delete a CBA item" description: "" - operationId: "createExternalCharges" + operationId: "deleteCBA" consumes: - "application/json" produces: - "application/json" parameters: - - name: "accountId" + - name: "invoiceId" in: "path" required: true type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - in: "body" - name: "body" + - name: "invoiceItemId" + in: "path" required: true - schema: - type: "array" - items: - $ref: "#/definitions/InvoiceItem" - - name: "requestedDate" - in: "query" - required: false type: "string" - format: "date" - - name: "autoCommit" - in: "query" - required: false - type: "boolean" - default: false - - name: "pluginProperty" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "accountId" in: "query" - required: false - type: "array" - items: - type: "string" - collectionFormat: "multi" + required: true + type: "string" + format: "uuid" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -6331,207 +6378,213 @@ paths: required: false type: "string" responses: - "201": - description: "Created external charge Successfully" - schema: - type: "array" - items: - $ref: "#/definitions/InvoiceItem" + "204": + description: "Successful operation" "400": - description: "Invalid account id supplied" + description: "Invalid account id, invoice id or invoice item id supplied" "404": - description: "Account not found" + description: "Account or invoice not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoices/manualPayTemplate/{locale}: + /1.0/kb/invoices/search/{searchKey}: get: tags: - "Invoice" - summary: "Retrieves the manualPay invoice template for the tenant" + summary: "Search invoices" description: "" - operationId: "getInvoiceMPTemplate" + operationId: "searchInvoices" produces: - - "text/html" + - "application/json" parameters: - - name: "locale" + - name: "searchKey" in: "path" required: true type: "string" pattern: ".*" + - name: "offset" + in: "query" + required: false + type: "integer" + default: 0 + format: "int64" + - name: "limit" + in: "query" + required: false + type: "integer" + default: 100 + format: "int64" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" schema: - type: "string" - "404": - description: "Template not found" + type: "array" + items: + $ref: "#/definitions/Invoice" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoices/{invoiceId}/auditLogsWithHistory: + /1.0/kb/invoices/pagination: get: tags: - "Invoice" - summary: "Retrieve invoice audit logs with history by id" + summary: "List invoices" description: "" - operationId: "getInvoiceAuditLogsWithHistory" + operationId: "getInvoices" produces: - "application/json" parameters: - - name: "invoiceId" - in: "path" - required: true + - name: "offset" + in: "query" + required: false + type: "integer" + default: 0 + format: "int64" + - name: "limit" + in: "query" + required: false + type: "integer" + default: 100 + format: "int64" + - name: "audit" + in: "query" + required: false type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: "200": description: "successful operation" schema: type: "array" items: - $ref: "#/definitions/AuditLog" - "404": - description: "Invoice not found" + $ref: "#/definitions/Invoice" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoices/manualPayTemplate: - post: + /1.0/kb/invoices/{invoiceId}/html: + get: tags: - "Invoice" - summary: "Upload the manualPay invoice template for the tenant" + summary: "Render an invoice as HTML" description: "" - operationId: "uploadInvoiceMPTemplate" - consumes: - - "text/html" + operationId: "getInvoiceAsHTML" produces: - "text/html" parameters: - - in: "body" - name: "body" - required: true - schema: - type: "string" - - name: "deleteIfExists" - in: "query" - required: false - type: "boolean" - default: false - - name: "X-Killbill-CreatedBy" - in: "header" + - name: "invoiceId" + in: "path" required: true type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" responses: "200": description: "successful operation" schema: type: "string" + "404": + description: "Invoice not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoices/dryRun: - post: + /1.0/kb/invoices/byNumber/{invoiceNumber}: + get: tags: - "Invoice" - summary: "Generate a dryRun invoice" + summary: "Retrieve an invoice by number" description: "" - operationId: "generateDryRunInvoice" - consumes: - - "application/json" + operationId: "getInvoiceByNumber" produces: - "application/json" parameters: - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/InvoiceDryRun" - - name: "accountId" - in: "query" + - name: "invoiceNumber" + in: "path" required: true - type: "string" - format: "uuid" - - name: "targetDate" + type: "integer" + pattern: "[0-9]+" + format: "int32" + - name: "withChildrenItems" in: "query" required: false - type: "string" - format: "date" - - name: "pluginProperty" + type: "boolean" + default: false + - 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: "200": description: "successful operation" schema: $ref: "#/definitions/Invoice" - "204": - description: "Nothing to generate" - "400": - description: "Invalid account id or target datetime supplied" + "404": + description: "Invoice not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/invoices/migration/{accountId}: + /1.0/kb/nodesInfo: + get: + tags: + - "NodesInfo" + summary: "Retrieve all the nodes infos" + description: "" + operationId: "getNodesInfo" + produces: + - "application/json" + parameters: [] + responses: + "200": + description: "successful operation" + schema: + type: "array" + items: + $ref: "#/definitions/NodeInfo" + security: + - basicAuth: [] post: tags: - - "Invoice" - summary: "Create a migration invoice" + - "NodesInfo" + summary: "Trigger a node command" description: "" - operationId: "createMigrationInvoice" + operationId: "triggerNodeCommand" 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: - $ref: "#/definitions/InvoiceItem" - - name: "targetDate" + $ref: "#/definitions/NodeCommand" + - name: "localNodeOnly" in: "query" required: false - type: "string" - format: "date" + type: "boolean" + default: false - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -6545,56 +6598,45 @@ paths: required: false type: "string" responses: - "201": - description: "Created migration invoice successfully" - schema: - $ref: "#/definitions/Invoice" + "202": + description: "Successful operation" "400": - description: "Invalid account id or target datetime supplied" + description: "Invalid node command supplied" security: - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/nodesInfo: + /1.0/kb/overdue/xml: get: tags: - - "NodesInfo" - summary: "Retrieve all the nodes infos" + - "Overdue" + summary: "Retrieve the overdue config as XML" description: "" - operationId: "getNodesInfo" + operationId: "getOverdueConfigXml" produces: - - "application/json" + - "text/xml" parameters: [] responses: "200": description: "successful operation" schema: - type: "array" - items: - $ref: "#/definitions/NodeInfo" + type: "string" security: - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] post: tags: - - "NodesInfo" - summary: "Trigger a node command" + - "Overdue" + summary: "Upload the full overdue config as XML" description: "" - operationId: "triggerNodeCommand" + operationId: "uploadOverdueConfigXml" consumes: - - "application/json" - produces: - - "application/json" + - "text/xml" parameters: - in: "body" name: "body" required: true schema: - $ref: "#/definitions/NodeCommand" - - name: "localNodeOnly" - in: "query" - required: false - type: "boolean" - default: false + type: "string" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -6608,12 +6650,16 @@ paths: required: false type: "string" responses: - "202": - description: "Successful operation" + "201": + description: "Successfully uploaded overdue config" + schema: + type: "string" "400": description: "Invalid node command supplied" security: - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/overdue: get: tags: @@ -6672,79 +6718,34 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/overdue/xml: - get: - tags: - - "Overdue" - summary: "Retrieve the overdue config as XML" - description: "" - operationId: "getOverdueConfigXml" - produces: - - "text/xml" - parameters: [] - responses: - "200": - description: "successful operation" - schema: - type: "string" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - post: - tags: - - "Overdue" - summary: "Upload the full overdue config as XML" - description: "" - operationId: "uploadOverdueConfigXml" - consumes: - - "text/xml" - 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: "Successfully uploaded overdue config" - schema: - type: "string" - "400": - description: "Invalid node command supplied" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/paymentGateways/hosted/form: + /1.0/kb/paymentGateways/hosted/form/{accountId}: post: tags: - "PaymentGateway" - summary: "Combo API to generate form data to redirect the customer to the gateway" + summary: "Generate form data to redirect the customer to the gateway" description: "" - operationId: "buildComboFormDescriptor" + operationId: "buildFormDescriptor" 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/ComboHostedPaymentPage" + $ref: "#/definitions/HostedPaymentPageFields" + - name: "paymentMethodId" + in: "query" + required: false + type: "string" + format: "uuid" - name: "controlPluginName" in: "query" required: false @@ -6776,40 +6777,34 @@ paths: description: "successful operation" schema: $ref: "#/definitions/HostedPaymentPageFormDescriptor" - "400": - description: "Invalid data for Account or PaymentMethod" + "404": + description: "Account not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/paymentGateways/hosted/form/{accountId}: + /1.0/kb/paymentGateways/notification/{pluginName}: post: tags: - "PaymentGateway" - summary: "Generate form data to redirect the customer to the gateway" - description: "" - operationId: "buildFormDescriptor" + summary: "Process a gateway notification" + description: "The response is built by the appropriate plugin" + operationId: "processNotification" consumes: - - "application/json" + - "*/*" produces: - "application/json" parameters: - - name: "accountId" + - name: "pluginName" in: "path" required: true type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" + pattern: ".*" - in: "body" name: "body" required: true schema: - $ref: "#/definitions/HostedPaymentPageFields" - - name: "paymentMethodId" - in: "query" - required: false - type: "string" - format: "uuid" + type: "string" - name: "controlPluginName" in: "query" required: false @@ -6838,37 +6833,28 @@ paths: type: "string" responses: "200": - description: "successful operation" - schema: - $ref: "#/definitions/HostedPaymentPageFormDescriptor" - "404": - description: "Account not found" + description: "Successful" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/paymentGateways/notification/{pluginName}: + /1.0/kb/paymentGateways/hosted/form: post: tags: - "PaymentGateway" - summary: "Process a gateway notification" - description: "The response is built by the appropriate plugin" - operationId: "processNotification" + summary: "Combo API to generate form data to redirect the customer to the gateway" + description: "" + operationId: "buildComboFormDescriptor" consumes: - - "*/*" + - "application/json" produces: - "application/json" parameters: - - name: "pluginName" - in: "path" - required: true - type: "string" - pattern: ".*" - in: "body" name: "body" required: true schema: - type: "string" + $ref: "#/definitions/ComboHostedPaymentPage" - name: "controlPluginName" in: "query" required: false @@ -6897,27 +6883,58 @@ paths: type: "string" responses: "200": - description: "Successful" + description: "successful operation" + schema: + $ref: "#/definitions/HostedPaymentPageFormDescriptor" + "400": + description: "Invalid data for Account or PaymentMethod" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/paymentMethods/{paymentMethodId}/customFields: + /1.0/kb/paymentMethods/search/{searchKey}: get: tags: - "PaymentMethod" - summary: "Retrieve payment method custom fields" + summary: "Search payment methods" description: "" - operationId: "getPaymentMethodCustomFields" + 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 @@ -6933,21 +6950,18 @@ paths: schema: type: "array" items: - $ref: "#/definitions/CustomField" - "400": - description: "Invalid payment method id supplied" + $ref: "#/definitions/PaymentMethod" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - post: + /1.0/kb/paymentMethods/{paymentMethodId}: + get: tags: - "PaymentMethod" - summary: "Add custom fields to payment method" + summary: "Retrieve a payment method by id" description: "" - operationId: "createPaymentMethodCustomFields" - consumes: - - "application/json" + operationId: "getPaymentMethod" produces: - "application/json" parameters: @@ -6957,32 +6971,181 @@ 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: "withPluginInfo" + in: "query" required: false - type: "string" - responses: - "201": - description: "Custom field created successfully" - schema: - type: "array" - items: - $ref: "#/definitions/CustomField" + type: "boolean" + default: false + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" + responses: + "200": + description: "successful operation" + schema: + $ref: "#/definitions/PaymentMethod" + "400": + description: "Invalid paymentMethodId supplied" + "404": + description: "Account or payment method not found" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + delete: + tags: + - "PaymentMethod" + summary: "Delete a payment method" + description: "" + operationId: "deletePaymentMethod" + produces: + - "application/json" + parameters: + - name: "paymentMethodId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "deleteDefaultPmWithAutoPayOff" + in: "query" + required: false + type: "boolean" + default: false + - name: "forceDefaultPmDeletion" + in: "query" + required: false + type: "boolean" + default: false + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + 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 paymentMethodId supplied" + "404": + description: "Account or payment method not found" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/paymentMethods/{paymentMethodId}/customFields: + get: + tags: + - "PaymentMethod" + summary: "Retrieve payment method custom fields" + description: "" + operationId: "getPaymentMethodCustomFields" + produces: + - "application/json" + parameters: + - name: "paymentMethodId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" + responses: + "200": + description: "successful operation" + schema: + type: "array" + items: + $ref: "#/definitions/CustomField" + "400": + description: "Invalid payment method id supplied" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + post: + tags: + - "PaymentMethod" + summary: "Add custom fields to payment method" + description: "" + operationId: "createPaymentMethodCustomFields" + consumes: + - "application/json" + produces: + - "application/json" + parameters: + - name: "paymentMethodId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + type: "array" + items: + $ref: "#/definitions/CustomField" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "201": + description: "Custom field created successfully" + schema: + type: "array" + items: + $ref: "#/definitions/CustomField" "400": description: "Invalid payment method id supplied" security: @@ -7109,32 +7272,25 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/paymentMethods/pagination: + /1.0/kb/paymentMethods: get: tags: - "PaymentMethod" - summary: "List payment methods" + summary: "Retrieve a payment method by external key" description: "" - operationId: "getPaymentMethods" + operationId: "getPaymentMethodByKey" produces: - "application/json" parameters: - - name: "offset" - in: "query" - required: false - type: "integer" - default: 0 - format: "int64" - - name: "limit" + - name: "externalKey" in: "query" - required: false - type: "integer" - default: 100 - format: "int64" - - name: "pluginName" + required: true + type: "string" + - name: "includedDeleted" in: "query" required: false - type: "string" + type: "boolean" + default: false - name: "withPluginInfo" in: "query" required: false @@ -7160,34 +7316,39 @@ paths: "200": description: "successful operation" schema: - type: "array" - items: - $ref: "#/definitions/PaymentMethod" + $ref: "#/definitions/PaymentMethod" + "404": + description: "Account or payment method not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/paymentMethods/{paymentMethodId}: + /1.0/kb/paymentMethods/pagination: get: tags: - "PaymentMethod" - summary: "Retrieve a payment method by id" + summary: "List payment methods" description: "" - operationId: "getPaymentMethod" + operationId: "getPaymentMethods" produces: - "application/json" parameters: - - name: "paymentMethodId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "includedDeleted" + - name: "offset" in: "query" required: false - type: "boolean" - default: 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 @@ -7213,47 +7374,75 @@ paths: "200": description: "successful operation" schema: - $ref: "#/definitions/PaymentMethod" - "400": - description: "Invalid paymentMethodId supplied" - "404": - description: "Account or payment method not found" + type: "array" + items: + $ref: "#/definitions/PaymentMethod" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - delete: + /1.0/kb/payments/{paymentId}/customFields: + get: tags: - - "PaymentMethod" - summary: "Delete a payment method" + - "Payment" + summary: "Retrieve payment custom fields" description: "" - operationId: "deletePaymentMethod" + operationId: "getPaymentCustomFields" produces: - "application/json" parameters: - - name: "paymentMethodId" + - name: "paymentId" in: "path" required: true type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "deleteDefaultPmWithAutoPayOff" - in: "query" - required: false - type: "boolean" - default: false - - name: "forceDefaultPmDeletion" + - name: "audit" in: "query" required: false - type: "boolean" - default: false - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: - type: "string" - collectionFormat: "multi" + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" + responses: + "200": + description: "successful operation" + schema: + type: "array" + items: + $ref: "#/definitions/CustomField" + "400": + description: "Invalid payment id supplied" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + post: + tags: + - "Payment" + summary: "Add custom fields to payment" + description: "" + operationId: "createPaymentCustomFields" + 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 @@ -7267,140 +7456,125 @@ paths: required: false type: "string" responses: - "204": - description: "Successful operation" + "201": + description: "Custom field created successfully" + schema: + type: "array" + items: + $ref: "#/definitions/CustomField" "400": - description: "Invalid paymentMethodId supplied" - "404": - description: "Account or payment method not found" + description: "Invalid payment id supplied" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/paymentMethods/search/{searchKey}: - get: + put: tags: - - "PaymentMethod" - summary: "Search payment methods" + - "Payment" + summary: "Modify custom fields to payment" description: "" - operationId: "searchPaymentMethods" + operationId: "modifyPaymentCustomFields" + consumes: + - "application/json" produces: - "application/json" parameters: - - name: "searchKey" + - name: "paymentId" in: "path" required: true type: "string" - pattern: ".*" - - name: "offset" - in: "query" - required: false - type: "integer" - default: 0 - format: "int64" - - name: "limit" - in: "query" - required: false - type: "integer" - default: 100 - format: "int64" - - name: "pluginName" - in: "query" - required: false + 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: "withPluginInfo" - in: "query" - required: false - type: "boolean" - default: false - - name: "pluginProperty" - in: "query" + - 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: - type: "array" - items: - $ref: "#/definitions/PaymentMethod" + "204": + description: "Successful operation" + "400": + description: "Invalid payment id supplied" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/paymentMethods: - get: + delete: tags: - - "PaymentMethod" - summary: "Retrieve a payment method by external key" + - "Payment" + summary: "Remove custom fields from payment payment" description: "" - operationId: "getPaymentMethodByKey" + operationId: "deletePaymentCustomFields" + consumes: + - "application/json" produces: - "application/json" parameters: - - name: "externalKey" - in: "query" + - name: "paymentId" + in: "path" required: true type: "string" - - name: "includedDeleted" - in: "query" - required: false - type: "boolean" - default: false - - name: "withPluginInfo" - in: "query" - required: false - type: "boolean" - default: false - - name: "pluginProperty" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "customField" 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: - $ref: "#/definitions/PaymentMethod" - "404": - description: "Account or payment method not found" + "204": + description: "Successful operation" + "400": + description: "Invalid payment id supplied" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/payments: + /1.0/kb/payments/{paymentId}: get: tags: - "Payment" - summary: "Retrieve a payment by external key" + summary: "Retrieve a payment by id" description: "" - operationId: "getPaymentByExternalKey" + operationId: "getPayment" produces: - "application/json" parameters: + - name: "paymentId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" - name: "withPluginInfo" in: "query" required: false @@ -7411,10 +7585,6 @@ paths: required: false type: "boolean" default: false - - name: "externalKey" - in: "query" - required: true - type: "string" - name: "pluginProperty" in: "query" required: false @@ -7436,6 +7606,8 @@ paths: description: "successful operation" schema: $ref: "#/definitions/Payment" + "400": + description: "Invalid paymentId supplied" "404": description: "Payment not found" security: @@ -7447,12 +7619,18 @@ paths: - "Payment" summary: "Capture an existing authorization" description: "" - operationId: "captureAuthorizationByExternalKey" + operationId: "captureAuthorization" 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 @@ -7489,6 +7667,8 @@ paths: description: "Payment transaction created successfully" schema: $ref: "#/definitions/Payment" + "400": + description: "Invalid paymentId supplied" "404": description: "Account or payment not found" "402": @@ -7510,12 +7690,18 @@ paths: - "Payment" summary: "Complete an existing transaction" description: "" - operationId: "completeTransactionByExternalKey" + operationId: "completeTransaction" 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 @@ -7550,6 +7736,8 @@ paths: responses: "204": description: "Successful operation" + "400": + description: "Invalid paymentId supplied" "404": description: "Account or payment not found" "402": @@ -7571,12 +7759,18 @@ paths: - "Payment" summary: "Void an existing payment" description: "" - operationId: "voidPaymentByExternalKey" + operationId: "voidPayment" 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 @@ -7611,6 +7805,8 @@ paths: responses: "204": description: "Successful operation" + "400": + description: "Invalid paymentId supplied" "404": description: "Account or payment not found" "402": @@ -7627,68 +7823,66 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/payments/{paymentId}/customFields: + /1.0/kb/payments/attempts/{paymentAttemptId}/auditLogsWithHistory: get: tags: - "Payment" - summary: "Retrieve payment custom fields" + summary: "Retrieve payment attempt audit logs with history by id" description: "" - operationId: "getPaymentCustomFields" + operationId: "getPaymentAttemptAuditLogsWithHistory" produces: - "application/json" parameters: - - name: "paymentId" + - name: "paymentAttemptId" 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/CustomField" - "400": - description: "Invalid payment id supplied" + $ref: "#/definitions/AuditLog" + "404": + description: "Account not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] + /1.0/kb/payments/chargebackReversals: post: tags: - "Payment" - summary: "Add custom fields to payment" + summary: "Record a chargeback reversal" description: "" - operationId: "createPaymentCustomFields" + operationId: "chargebackReversalPaymentByExternalKey" 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" + $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 @@ -7703,41 +7897,43 @@ paths: type: "string" responses: "201": - description: "Custom field created successfully" + description: "Payment transaction created successfully" schema: - type: "array" - items: - $ref: "#/definitions/CustomField" - "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: [] - put: + /1.0/kb/payments/{paymentTransactionId}/cancelScheduledPaymentTransaction: + delete: tags: - "Payment" - summary: "Modify custom fields to payment" + summary: "Cancels a scheduled payment attempt retry" description: "" - operationId: "modifyPaymentCustomFields" + operationId: "cancelScheduledPaymentTransactionById" consumes: - "application/json" produces: - "application/json" parameters: - - name: "paymentId" + - name: "paymentTransactionId" 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 @@ -7754,36 +7950,27 @@ paths: "204": description: "Successful operation" "400": - description: "Invalid payment id supplied" + description: "Invalid paymentTransactionId supplied" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] + /1.0/kb/payments/cancelScheduledPaymentTransaction: delete: tags: - "Payment" - summary: "Remove custom fields from payment payment" + summary: "Cancels a scheduled payment attempt retry" description: "" - operationId: "deletePaymentCustomFields" + operationId: "cancelScheduledPaymentTransactionByExternalKey" consumes: - "application/json" produces: - "application/json" parameters: - - name: "paymentId" - in: "path" + - name: "transactionExternalKey" + in: "query" required: true type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "customField" - in: "query" - required: false - type: "array" - items: - type: "string" - format: "uuid" - collectionFormat: "multi" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -7800,18 +7987,18 @@ paths: "204": description: "Successful operation" "400": - description: "Invalid payment id supplied" + description: "Invalid paymentTransactionExternalKey supplied" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/payments/{paymentId}: + /1.0/kb/payments/{paymentId}/tags: get: tags: - "Payment" - summary: "Retrieve a payment by id" + summary: "Retrieve payment payment tags" description: "" - operationId: "getPayment" + operationId: "getPaymentTags" produces: - "application/json" parameters: @@ -7821,23 +8008,11 @@ paths: type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "withPluginInfo" - in: "query" - required: false - type: "boolean" - default: false - - name: "withAttempts" + - 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 @@ -7851,11 +8026,13 @@ paths: "200": description: "successful operation" schema: - $ref: "#/definitions/Payment" + type: "array" + items: + $ref: "#/definitions/Tag" "400": - description: "Invalid paymentId supplied" + description: "Invalid payment id supplied" "404": - description: "Payment not found" + description: "Invoice not found" security: - basicAuth: [] - Killbill Api Key: [] @@ -7863,9 +8040,9 @@ paths: post: tags: - "Payment" - summary: "Capture an existing authorization" + summary: "Add tags to payment payment" description: "" - operationId: "captureAuthorization" + operationId: "createPaymentTags" consumes: - "application/json" produces: @@ -7881,21 +8058,10 @@ paths: 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 @@ -7910,33 +8076,23 @@ paths: type: "string" responses: "201": - description: "Payment transaction created successfully" + description: "Tag created successfully" schema: - $ref: "#/definitions/Payment" + type: "array" + items: + $ref: "#/definitions/Tag" "400": - description: "Invalid paymentId supplied" - "404": - description: "Account or payment not found" - "402": - description: "Transaction declined by gateway" - "422": - description: "Payment is aborted by a control plugin" - "502": - description: "Failed to submit payment transaction" - "503": - description: "Payment in unknown status, failed to receive gateway response" - "504": - description: "Payment operation timeout" + description: "Invalid payment id supplied" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - put: + delete: tags: - "Payment" - summary: "Complete an existing transaction" + summary: "Remove tags from payment payment" description: "" - operationId: "completeTransaction" + operationId: "deletePaymentTags" consumes: - "application/json" produces: @@ -7948,6 +8104,47 @@ 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 + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "204": + description: "Successful operation" + "400": + description: "Invalid payment id supplied" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/payments/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 @@ -7980,10 +8177,10 @@ paths: required: false type: "string" responses: - "204": - description: "Successful operation" - "400": - description: "Invalid paymentId supplied" + "201": + description: "Payment transaction created successfully" + schema: + $ref: "#/definitions/Payment" "404": description: "Account or payment not found" "402": @@ -8000,23 +8197,18 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - delete: + /1.0/kb/payments/chargebacks: + post: tags: - "Payment" - summary: "Void an existing payment" + summary: "Record a chargeback" description: "" - operationId: "voidPayment" + operationId: "chargebackPaymentByExternalKey" 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 @@ -8049,10 +8241,10 @@ paths: required: false type: "string" responses: - "204": - description: "Successful operation" - "400": - description: "Invalid paymentId supplied" + "201": + description: "Payment transaction created successfully" + schema: + $ref: "#/definitions/Payment" "404": description: "Account or payment not found" "402": @@ -8069,52 +8261,92 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/payments/{paymentTransactionId}/cancelScheduledPaymentTransaction: - delete: + /1.0/kb/payments/{paymentId}/auditLogsWithHistory: + get: tags: - "Payment" - summary: "Cancels a scheduled payment attempt retry" + summary: "Retrieve payment audit logs with history by id" description: "" - operationId: "cancelScheduledPaymentTransactionById" - consumes: - - "application/json" + operationId: "getPaymentAuditLogsWithHistory" produces: - "application/json" parameters: - - name: "paymentTransactionId" + - name: "paymentId" in: "path" required: true type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - name: "X-Killbill-CreatedBy" - in: "header" + 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/payments: + get: + tags: + - "Payment" + summary: "Retrieve a payment by external key" + description: "" + operationId: "getPaymentByExternalKey" + 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" required: true type: "string" - - name: "X-Killbill-Reason" - in: "header" + - name: "pluginProperty" + in: "query" required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "audit" + in: "query" required: false type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: - "204": - description: "Successful operation" - "400": - description: "Invalid paymentTransactionId supplied" + "200": + description: "successful operation" + schema: + $ref: "#/definitions/Payment" + "404": + description: "Payment not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/payments/chargebackReversals: post: tags: - "Payment" - summary: "Record a chargeback reversal" + summary: "Capture an existing authorization" description: "" - operationId: "chargebackReversalPaymentByExternalKey" + operationId: "captureAuthorizationByExternalKey" consumes: - "application/json" produces: @@ -8172,22 +8404,36 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/payments/cancelScheduledPaymentTransaction: - delete: + put: tags: - "Payment" - summary: "Cancels a scheduled payment attempt retry" + summary: "Complete an existing transaction" description: "" - operationId: "cancelScheduledPaymentTransactionByExternalKey" + operationId: "completeTransactionByExternalKey" consumes: - "application/json" produces: - "application/json" parameters: - - name: "transactionExternalKey" - in: "query" + - in: "body" + name: "body" required: true - type: "string" + 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 @@ -8203,92 +8449,90 @@ 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 not found" + description: "Account or payment not found" + "402": + description: "Transaction declined by gateway" + "422": + description: "Payment is aborted by a control plugin" + "502": + description: "Failed to submit payment transaction" + "503": + description: "Payment in unknown status, failed to receive gateway response" + "504": + description: "Payment operation timeout" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/payments/{paymentId}/tags: - get: + delete: tags: - "Payment" - summary: "Retrieve payment payment tags" + summary: "Void an existing payment" description: "" - operationId: "getPaymentTags" + operationId: "voidPaymentByExternalKey" + consumes: + - "application/json" produces: - "application/json" parameters: - - name: "paymentId" - in: "path" + - in: "body" + name: "body" required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "includedDeleted" + schema: + $ref: "#/definitions/PaymentTransaction" + - name: "controlPluginName" in: "query" required: false - type: "boolean" - default: false - - name: "audit" + 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" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" responses: - "200": - description: "successful operation" - schema: - type: "array" - items: - $ref: "#/definitions/Tag" - "400": - description: "Invalid payment id supplied" + "204": + description: "Successful operation" "404": - description: "Invoice not found" + description: "Account or payment not found" + "402": + description: "Transaction declined by gateway" + "422": + description: "Payment is aborted by a control plugin" + "502": + description: "Failed to submit payment transaction" + "503": + description: "Payment in unknown status, failed to receive gateway response" + "504": + description: "Payment operation timeout" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] + /1.0/kb/payments/{paymentId}/chargebackReversals: post: tags: - "Payment" - summary: "Add tags to payment payment" + summary: "Record a chargeback reversal" description: "" - operationId: "createPaymentTags" + operationId: "chargebackReversalPayment" consumes: - "application/json" produces: @@ -8304,10 +8548,21 @@ paths: 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 @@ -8322,136 +8577,32 @@ 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 payment id 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: [] - delete: + /1.0/kb/payments/{paymentId}/chargebacks: + post: tags: - "Payment" - summary: "Remove tags from payment payment" - description: "" - operationId: "deletePaymentTags" - consumes: - - "application/json" - produces: - - "application/json" - parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "tagDef" - in: "query" - required: false - type: "array" - items: - type: "string" - format: "uuid" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "204": - description: "Successful operation" - "400": - description: "Invalid payment id supplied" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/payments/search/{searchKey}: - get: - tags: - - "Payment" - summary: "Search payments" - description: "" - operationId: "searchPayments" - produces: - - "application/json" - parameters: - - name: "searchKey" - in: "path" - required: true - type: "string" - pattern: ".*" - - name: "offset" - in: "query" - required: false - type: "integer" - default: 0 - format: "int64" - - name: "limit" - in: "query" - required: false - type: "integer" - default: 100 - format: "int64" - - name: "withPluginInfo" - in: "query" - required: false - type: "boolean" - default: false - - name: "withAttempts" - in: "query" - required: false - type: "boolean" - default: false - - name: "pluginName" - in: "query" - required: false - type: "string" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: - type: "string" - collectionFormat: "multi" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" - responses: - "200": - description: "successful operation" - schema: - type: "array" - items: - $ref: "#/definitions/Payment" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/payments/{paymentId}/chargebacks: - post: - tags: - - "Payment" - summary: "Record a chargeback" + summary: "Record a chargeback" description: "" operationId: "chargebackPayment" consumes: @@ -8712,30 +8863,47 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/payments/refunds: - post: + /1.0/kb/payments/search/{searchKey}: + get: tags: - "Payment" - summary: "Refund an existing payment" + summary: "Search payments" description: "" - operationId: "refundPaymentByExternalKey" - consumes: - - "application/json" + operationId: "searchPayments" produces: - "application/json" parameters: - - in: "body" - name: "body" + - name: "searchKey" + in: "path" required: true - schema: - $ref: "#/definitions/PaymentTransaction" - - name: "controlPluginName" + type: "string" + pattern: ".*" + - name: "offset" in: "query" required: false - type: "array" - items: - type: "string" - collectionFormat: "multi" + type: "integer" + default: 0 + format: "int64" + - name: "limit" + in: "query" + required: false + type: "integer" + default: 100 + format: "int64" + - name: "withPluginInfo" + in: "query" + required: false + type: "boolean" + default: false + - name: "withAttempts" + in: "query" + required: false + type: "boolean" + default: false + - name: "pluginName" + in: "query" + required: false + type: "string" - name: "pluginProperty" in: "query" required: false @@ -8743,76 +8911,64 @@ paths: 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" + - 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" - "404": - description: "Account or payment not found" - "402": - description: "Transaction declined by gateway" - "422": - description: "Payment is aborted by a control plugin" - "502": - description: "Failed to submit payment transaction" - "503": - description: "Payment in unknown status, failed to receive gateway response" - "504": - description: "Payment operation timeout" + type: "array" + items: + $ref: "#/definitions/Payment" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/payments/{paymentId}/chargebackReversals: + /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/roles: post: tags: - - "Payment" - summary: "Record a chargeback reversal" + - "Security" + summary: "Add a new role definition)" description: "" - operationId: "chargebackReversalPayment" + operationId: "addRoleDefinition" 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" + $ref: "#/definitions/RoleDefinition" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -8827,34 +8983,17 @@ paths: type: "string" responses: "201": - description: "Payment transaction created successfully" + description: "Role definition 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" + $ref: "#/definitions/RoleDefinition" security: - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/payments/chargebacks: - post: + put: tags: - - "Payment" - summary: "Record a chargeback" + - "Security" + summary: "Update a new role definition)" description: "" - operationId: "chargebackPaymentByExternalKey" + operationId: "updateRoleDefinition" consumes: - "application/json" produces: @@ -8864,21 +9003,7 @@ paths: 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" + $ref: "#/definitions/RoleDefinition" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -8892,62 +9017,17 @@ paths: 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/payments/{paymentId}/auditLogsWithHistory: - get: - tags: - - "Payment" - summary: "Retrieve payment audit logs with history by id" - description: "" - operationId: "getPaymentAuditLogsWithHistory" - produces: - - "application/json" - parameters: - - name: "paymentId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - responses: - "200": - description: "successful operation" - schema: - type: "array" - items: - $ref: "#/definitions/AuditLog" - "404": - description: "Account not found" + "204": + description: "Successful operation" security: - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/pluginsInfo: + /1.0/kb/security/permissions: get: tags: - - "PluginInfo" - summary: "Retrieve the list of registered plugins" + - "Security" + summary: "List user permissions" description: "" - operationId: "getPluginsInfo" + operationId: "getCurrentUserPermissions" produces: - "application/json" parameters: [] @@ -8957,11 +9037,9 @@ paths: schema: type: "array" items: - $ref: "#/definitions/PluginInfo" + type: "string" security: - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] /1.0/kb/security/subject: get: tags: @@ -8979,49 +9057,36 @@ paths: $ref: "#/definitions/Subject" security: - basicAuth: [] - /1.0/kb/security/users: - post: + /1.0/kb/security/users/{username}/roles: + get: tags: - "Security" - summary: "Add a new user with roles (to make api requests)" + summary: "Get roles associated to a user" description: "" - operationId: "addUserRoles" - consumes: - - "application/json" + operationId: "getUserRoles" produces: - "application/json" parameters: - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/UserRoles" - - name: "X-Killbill-CreatedBy" - in: "header" + - name: "username" + in: "path" required: true type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" + pattern: ".*" responses: - "201": - description: "User role created successfully" + "200": + description: "successful operation" schema: $ref: "#/definitions/UserRoles" + "404": + description: "The user does not exist or has been inactivated" security: - basicAuth: [] - /1.0/kb/security/users/{username}/password: put: tags: - "Security" - summary: "Update a user password" + summary: "Update roles associated to a user" description: "" - operationId: "updateUserPassword" + operationId: "updateUserRoles" consumes: - "application/json" produces: @@ -9054,17 +9119,17 @@ paths: description: "Successful operation" security: - basicAuth: [] - /1.0/kb/security/users/{username}/roles: + /1.0/kb/security/roles/{role}: get: tags: - "Security" - summary: "Get roles associated to a user" + summary: "Get role definition" description: "" - operationId: "getUserRoles" + operationId: "getRoleDefinition" produces: - "application/json" parameters: - - name: "username" + - name: "role" in: "path" required: true type: "string" @@ -9073,17 +9138,16 @@ paths: "200": description: "successful operation" schema: - $ref: "#/definitions/UserRoles" - "404": - description: "The user does not exist or has been inactivated" + $ref: "#/definitions/RoleDefinition" security: - basicAuth: [] + /1.0/kb/security/users/{username}/password: put: tags: - "Security" - summary: "Update roles associated to a user" + summary: "Update a user password" description: "" - operationId: "updateUserRoles" + operationId: "updateUserPassword" consumes: - "application/json" produces: @@ -9116,13 +9180,13 @@ paths: description: "Successful operation" security: - basicAuth: [] - /1.0/kb/security/roles: + /1.0/kb/security/users: post: tags: - "Security" - summary: "Add a new role definition)" + summary: "Add a new user with roles (to make api requests)" description: "" - operationId: "addRoleDefinition" + operationId: "addUserRoles" consumes: - "application/json" produces: @@ -9132,7 +9196,7 @@ paths: name: "body" required: true schema: - $ref: "#/definitions/RoleDefinition" + $ref: "#/definitions/UserRoles" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -9147,42 +9211,9 @@ paths: type: "string" responses: "201": - description: "Role definition created successfully" + description: "User role created successfully" schema: - $ref: "#/definitions/RoleDefinition" - security: - - basicAuth: [] - put: - tags: - - "Security" - summary: "Update a new role definition)" - description: "" - operationId: "updateRoleDefinition" - consumes: - - "application/json" - produces: - - "application/json" - parameters: - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/RoleDefinition" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "204": - description: "Successful operation" + $ref: "#/definitions/UserRoles" security: - basicAuth: [] /1.0/kb/security/users/{username}: @@ -9219,47 +9250,6 @@ paths: description: "Successful operation" security: - basicAuth: [] - /1.0/kb/security/roles/{role}: - get: - tags: - - "Security" - summary: "Get role definition" - description: "" - operationId: "getRoleDefinition" - produces: - - "application/json" - parameters: - - name: "role" - in: "path" - required: true - type: "string" - pattern: ".*" - responses: - "200": - description: "successful operation" - schema: - $ref: "#/definitions/RoleDefinition" - security: - - basicAuth: [] - /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/subscriptions/{subscriptionId}/customFields: get: tags: @@ -9434,17 +9424,17 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/subscriptions/{subscriptionId}/auditLogsWithHistory: + /1.0/kb/subscriptions/events/{eventId}/auditLogsWithHistory: get: tags: - "Subscription" - summary: "Retrieve subscription audit logs with history by id" + summary: "Retrieve subscription event audit logs with history by id" description: "" - operationId: "getSubscriptionAuditLogsWithHistory" + operationId: "getSubscriptionEventAuditLogsWithHistory" produces: - "application/json" parameters: - - name: "subscriptionId" + - name: "eventId" in: "path" required: true type: "string" @@ -9458,22 +9448,22 @@ paths: items: $ref: "#/definitions/AuditLog" "404": - description: "Subscription not found" + description: "Subscription event not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/subscriptions/events/{eventId}/auditLogsWithHistory: + /1.0/kb/subscriptions/{subscriptionId}/auditLogsWithHistory: get: tags: - "Subscription" - summary: "Retrieve subscription event audit logs with history by id" + summary: "Retrieve subscription audit logs with history by id" description: "" - operationId: "getSubscriptionEventAuditLogsWithHistory" + operationId: "getSubscriptionAuditLogsWithHistory" produces: - "application/json" parameters: - - name: "eventId" + - name: "subscriptionId" in: "path" required: true type: "string" @@ -9487,7 +9477,7 @@ paths: items: $ref: "#/definitions/AuditLog" "404": - description: "Subscription event not found" + description: "Subscription not found" security: - basicAuth: [] - Killbill Api Key: [] @@ -9627,120 +9617,6 @@ 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: [] - 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/Subscription" - - name: "entitlementDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "billingDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "renameKeyIfExistsAndUnused" - in: "query" - required: false - type: "boolean" - default: true - - name: "migrated" - in: "query" - required: false - type: "boolean" - default: false - - name: "skipResponse" - in: "query" - required: false - type: "boolean" - default: false - - name: "callCompletion" - in: "query" - required: false - type: "boolean" - default: false - - name: "callTimeoutSec" - in: "query" - required: false - type: "integer" - default: 3 - format: "int64" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: - type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "201": - description: "Subscription created successfully" - schema: - $ref: "#/definitions/Subscription" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] /1.0/kb/subscriptions/{subscriptionId}: get: tags: @@ -9938,66 +9814,6 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/subscriptions/{subscriptionId}/block: - post: - tags: - - "Subscription" - summary: "Block a subscription" - description: "" - operationId: "addSubscriptionBlockingState" - consumes: - - "application/json" - parameters: - - name: "subscriptionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/BlockingState" - - name: "requestedDate" - in: "query" - required: false - type: "string" - format: "date" - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: - type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "201": - description: "Blocking state created successfully" - schema: - type: "array" - items: - $ref: "#/definitions/BlockingState" - "400": - description: "Invalid subscription id supplied" - "404": - description: "Subscription not found" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] /1.0/kb/subscriptions/createSubscriptionWithAddOns: post: tags: @@ -10166,102 +9982,116 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/subscriptions/{subscriptionId}/undoChangePlan: - put: + /1.0/kb/subscriptions: + get: tags: - "Subscription" - summary: "Undo a pending change plan on an entitlement" + summary: "Retrieve a subscription by external key" description: "" - operationId: "undoChangeSubscriptionPlan" + operationId: "getSubscriptionByKey" produces: - "application/json" parameters: - - name: "subscriptionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "pluginProperty" + - name: "externalKey" 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" + - name: "audit" + in: "query" required: false type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" responses: - "204": - description: "Successful operation" - "400": - description: "Invalid subscription id supplied" + "200": + description: "successful operation" + schema: + $ref: "#/definitions/Subscription" "404": - description: "Entitlement not found" + description: "Subscription not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/subscriptions/{subscriptionId}/bcd: - put: + post: tags: - "Subscription" - summary: "Update the BCD associated to a subscription" + summary: "Create a subscription" description: "" - operationId: "updateSubscriptionBCD" + operationId: "createSubscription" consumes: - "application/json" produces: - "application/json" parameters: - - name: "subscriptionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - in: "body" name: "body" required: true schema: $ref: "#/definitions/Subscription" - - name: "effectiveFromDate" + - name: "entitlementDate" in: "query" required: false type: "string" format: "date" - - name: "forceNewBcdWithPastEffectiveDate" + - name: "billingDate" in: "query" required: false - type: "boolean" - default: false - - name: "X-Killbill-CreatedBy" - in: "header" - required: true type: "string" - - name: "X-Killbill-Reason" - in: "header" + format: "date" + - name: "renameKeyIfExistsAndUnused" + in: "query" required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" + type: "boolean" + default: true + - name: "migrated" + in: "query" + required: false + type: "boolean" + default: false + - name: "skipResponse" + in: "query" + required: false + type: "boolean" + default: false + - name: "callCompletion" + in: "query" + required: false + type: "boolean" + default: false + - name: "callTimeoutSec" + in: "query" + required: false + type: "integer" + default: 3 + format: "int64" + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" required: false type: "string" responses: - "204": - description: "Successful operation" - "400": - description: "Invalid entitlement supplied" + "201": + description: "Subscription created successfully" + schema: + $ref: "#/definitions/Subscription" security: - basicAuth: [] - Killbill Api Key: [] @@ -10312,17 +10142,15 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/subscriptions/{subscriptionId}/quantity: - put: + /1.0/kb/subscriptions/{subscriptionId}/block: + post: tags: - "Subscription" - summary: "Update the quantity associated to a subscription" + summary: "Block a subscription" description: "" - operationId: "updateSubscriptionQuantity" + operationId: "addSubscriptionBlockingState" consumes: - "application/json" - produces: - - "application/json" parameters: - name: "subscriptionId" in: "path" @@ -10334,17 +10162,19 @@ paths: name: "body" required: true schema: - $ref: "#/definitions/Subscription" - - name: "effectiveFromDate" + $ref: "#/definitions/BlockingState" + - name: "requestedDate" in: "query" required: false type: "string" format: "date" - - name: "forceNewQuantityWithPastEffectiveDate" + - 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 @@ -10358,65 +10188,99 @@ paths: required: false type: "string" responses: - "204": - description: "Successful operation" + "201": + description: "Blocking state created successfully" + schema: + type: "array" + items: + $ref: "#/definitions/BlockingState" "400": - description: "Invalid entitlement supplied" + description: "Invalid subscription id supplied" + "404": + description: "Subscription not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/tagDefinitions/{tagDefinitionId}: - get: + /1.0/kb/subscriptions/{subscriptionId}/undoChangePlan: + put: tags: - - "TagDefinition" - summary: "Retrieve a tag definition" + - "Subscription" + summary: "Undo a pending change plan on an entitlement" description: "" - operationId: "getTagDefinition" + operationId: "undoChangeSubscriptionPlan" produces: - "application/json" parameters: - - name: "tagDefinitionId" + - name: "subscriptionId" in: "path" required: true type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" - - 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" - schema: - $ref: "#/definitions/TagDefinition" + "204": + description: "Successful operation" "400": - description: "Invalid tagDefinitionId supplied" + description: "Invalid subscription id supplied" + "404": + description: "Entitlement not found" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - delete: + /1.0/kb/subscriptions/{subscriptionId}/bcd: + put: tags: - - "TagDefinition" - summary: "Delete a tag definition" + - "Subscription" + summary: "Update the BCD associated to a subscription" description: "" - operationId: "deleteTagDefinition" + operationId: "updateSubscriptionBCD" + consumes: + - "application/json" produces: - "application/json" parameters: - - name: "tagDefinitionId" + - name: "subscriptionId" in: "path" required: true type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/Subscription" + - name: "effectiveFromDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "forceNewBcdWithPastEffectiveDate" + in: "query" + required: false + type: "boolean" + default: false - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -10433,36 +10297,61 @@ paths: "204": description: "Successful operation" "400": - description: "Invalid tagDefinitionId supplied" + description: "Invalid entitlement supplied" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/tagDefinitions/{tagDefinitionId}/auditLogsWithHistory: - get: + /1.0/kb/subscriptions/{subscriptionId}/quantity: + put: tags: - - "TagDefinition" - summary: "Retrieve tag definition audit logs with history by id" + - "Subscription" + summary: "Update the quantity associated to a subscription" description: "" - operationId: "getTagDefinitionAuditLogsWithHistory" + operationId: "updateSubscriptionQuantity" + consumes: + - "application/json" produces: - "application/json" parameters: - - name: "tagDefinitionId" + - name: "subscriptionId" in: "path" required: true type: "string" pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" format: "uuid" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/Subscription" + - name: "effectiveFromDate" + in: "query" + required: false + type: "string" + format: "date" + - name: "forceNewQuantityWithPastEffectiveDate" + in: "query" + required: false + type: "boolean" + default: false + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" responses: - "200": - description: "successful operation" - schema: - type: "array" - items: - $ref: "#/definitions/AuditLog" - "404": - description: "Account not found" + "204": + description: "Successful operation" + "400": + description: "Invalid entitlement supplied" security: - basicAuth: [] - Killbill Api Key: [] @@ -10536,28 +10425,22 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/tags/pagination: + /1.0/kb/tagDefinitions/{tagDefinitionId}: get: tags: - - "Tag" - summary: "List tags" + - "TagDefinition" + summary: "Retrieve a tag definition" description: "" - operationId: "getTags" + operationId: "getTagDefinition" 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: "tagDefinitionId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" - name: "audit" in: "query" required: false @@ -10571,31 +10454,91 @@ paths: "200": description: "successful operation" schema: - type: "array" - items: - $ref: "#/definitions/Tag" + $ref: "#/definitions/TagDefinition" + "400": + description: "Invalid tagDefinitionId supplied" security: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/tags/search/{searchKey}: - get: + delete: tags: - - "Tag" - summary: "Search tags" + - "TagDefinition" + summary: "Delete a tag definition" description: "" - operationId: "searchTags" + operationId: "deleteTagDefinition" produces: - "application/json" parameters: - - name: "searchKey" + - name: "tagDefinitionId" in: "path" required: true type: "string" - pattern: ".*" - - name: "offset" - in: "query" - required: false + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "204": + description: "Successful operation" + "400": + description: "Invalid tagDefinitionId supplied" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/tagDefinitions/{tagDefinitionId}/auditLogsWithHistory: + get: + tags: + - "TagDefinition" + summary: "Retrieve tag definition audit logs with history by id" + description: "" + operationId: "getTagDefinitionAuditLogsWithHistory" + produces: + - "application/json" + parameters: + - name: "tagDefinitionId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + responses: + "200": + description: "successful operation" + schema: + type: "array" + items: + $ref: "#/definitions/AuditLog" + "404": + description: "Account not found" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/tags/pagination: + get: + tags: + - "Tag" + summary: "List tags" + description: "" + operationId: "getTags" + produces: + - "application/json" + parameters: + - name: "offset" + in: "query" + required: false type: "integer" default: 0 format: "int64" @@ -10654,6 +10597,53 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] + /1.0/kb/tags/search/{searchKey}: + get: + tags: + - "Tag" + summary: "Search tags" + description: "" + operationId: "searchTags" + produces: + - "application/json" + parameters: + - name: "searchKey" + in: "path" + required: true + type: "string" + pattern: ".*" + - name: "offset" + in: "query" + required: false + type: "integer" + default: 0 + format: "int64" + - name: "limit" + in: "query" + required: false + type: "integer" + default: 100 + format: "int64" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" + responses: + "200": + description: "successful operation" + schema: + type: "array" + items: + $ref: "#/definitions/Tag" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/tenants/uploadPluginPaymentStateMachineConfig/{pluginName}: get: tags: @@ -10757,86 +10747,16 @@ 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/userKeyValue/{keyName}: + /1.0/kb/tenants/uploadPerTenantConfig: get: tags: - "Tenant" - summary: "Retrieve a per tenant user key/value" + summary: "Retrieve a per tenant configuration (system properties)" description: "" - operationId: "getUserKeyValue" + operationId: "getPerTenantConfiguration" produces: - "application/json" - parameters: - - name: "keyName" - in: "path" - required: true - type: "string" - pattern: ".*" + parameters: [] responses: "200": description: "successful operation" @@ -10851,19 +10771,14 @@ paths: post: tags: - "Tenant" - summary: "Add a per tenant user key/value" + summary: "Add a per tenant configuration (system properties)" description: "" - operationId: "insertUserKeyValue" + operationId: "uploadPerTenantConfiguration" consumes: - "text/plain" produces: - "application/json" parameters: - - name: "keyName" - in: "path" - required: true - type: "string" - pattern: ".*" - in: "body" name: "body" required: true @@ -10883,7 +10798,7 @@ paths: type: "string" responses: "201": - description: "Per tenant config uploaded successfully" + description: "Per tenant configuration uploaded successfully" schema: $ref: "#/definitions/TenantKeyValue" "400": @@ -10895,15 +10810,10 @@ paths: delete: tags: - "Tenant" - summary: "Delete a per tenant user key/value" + summary: "Delete a per tenant configuration (system properties)" description: "" - operationId: "deleteUserKeyValue" + operationId: "deletePerTenantConfiguration" parameters: - - name: "keyName" - in: "path" - required: true - type: "string" - pattern: ".*" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -10925,31 +10835,30 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/tenants/{tenantId}: + /1.0/kb/tenants/uploadPerTenantConfig/{keyPrefix}/search: get: tags: - "Tenant" - summary: "Retrieve a tenant by id" + summary: "Retrieve a per tenant key value based on key prefix" description: "" - operationId: "getTenant" + operationId: "getAllPluginConfiguration" produces: - "application/json" parameters: - - name: "tenantId" + - name: "keyPrefix" in: "path" required: true type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" + pattern: ".*" responses: "200": description: "successful operation" schema: - $ref: "#/definitions/Tenant" + type: "array" + items: + $ref: "#/definitions/TenantKeyValue" "400": description: "Invalid tenantId supplied" - "404": - description: "Tenant not found" security: - basicAuth: [] - Killbill Api Key: [] @@ -11144,49 +11053,55 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/tenants/uploadPerTenantConfig/{keyPrefix}/search: + /1.0/kb/tenants/{tenantId}: get: tags: - "Tenant" - summary: "Retrieve a per tenant key value based on key prefix" + summary: "Retrieve a tenant by id" description: "" - operationId: "getAllPluginConfiguration" + operationId: "getTenant" produces: - "application/json" parameters: - - name: "keyPrefix" + - name: "tenantId" in: "path" required: true type: "string" - pattern: ".*" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" responses: "200": description: "successful operation" schema: - type: "array" - items: - $ref: "#/definitions/TenantKeyValue" + $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/uploadPerTenantConfig: + /1.0/kb/tenants/userKeyValue/{keyName}: get: tags: - "Tenant" - summary: "Retrieve a per tenant configuration (system properties)" + summary: "Retrieve a per tenant user key/value" description: "" - operationId: "getPerTenantConfiguration" + operationId: "getUserKeyValue" produces: - "application/json" - parameters: [] - responses: - "200": - description: "successful operation" - schema: - $ref: "#/definitions/TenantKeyValue" + parameters: + - name: "keyName" + in: "path" + required: true + type: "string" + pattern: ".*" + responses: + "200": + description: "successful operation" + schema: + $ref: "#/definitions/TenantKeyValue" "400": description: "Invalid tenantId supplied" security: @@ -11196,14 +11111,19 @@ paths: post: tags: - "Tenant" - summary: "Add a per tenant configuration (system properties)" + summary: "Add a per tenant user key/value" description: "" - operationId: "uploadPerTenantConfiguration" + operationId: "insertUserKeyValue" consumes: - "text/plain" produces: - "application/json" parameters: + - name: "keyName" + in: "path" + required: true + type: "string" + pattern: ".*" - in: "body" name: "body" required: true @@ -11223,7 +11143,7 @@ paths: type: "string" responses: "201": - description: "Per tenant configuration uploaded successfully" + description: "Per tenant config uploaded successfully" schema: $ref: "#/definitions/TenantKeyValue" "400": @@ -11235,10 +11155,15 @@ paths: delete: tags: - "Tenant" - summary: "Delete a per tenant configuration (system properties)" + summary: "Delete a per tenant user key/value" description: "" - operationId: "deletePerTenantConfiguration" + operationId: "deleteUserKeyValue" parameters: + - name: "keyName" + in: "path" + required: true + type: "string" + pattern: ".*" - name: "X-Killbill-CreatedBy" in: "header" required: true @@ -11260,6 +11185,229 @@ 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/paymentTransactions: + get: + tags: + - "PaymentTransaction" + summary: "Retrieve a payment by transaction external key" + description: "" + operationId: "getPaymentByTransactionExternalKey" + produces: + - "application/json" + parameters: + - name: "transactionExternalKey" + in: "query" + required: true + type: "string" + - name: "withPluginInfo" + in: "query" + required: false + type: "boolean" + default: false + - name: "withAttempts" + in: "query" + required: false + type: "boolean" + default: false + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" + responses: + "200": + description: "successful operation" + schema: + $ref: "#/definitions/Payment" + "404": + description: "Payment not found" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + /1.0/kb/paymentTransactions/{transactionId}: + get: + tags: + - "PaymentTransaction" + summary: "Retrieve a payment by transaction id" + description: "" + operationId: "getPaymentByTransactionId" + produces: + - "application/json" + parameters: + - name: "transactionId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - name: "withPluginInfo" + in: "query" + required: false + type: "boolean" + default: false + - name: "withAttempts" + in: "query" + required: false + type: "boolean" + default: false + - name: "pluginProperty" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "audit" + in: "query" + required: false + type: "string" + default: "NONE" + enum: + - "FULL" + - "MINIMAL" + - "NONE" + responses: + "200": + description: "successful operation" + schema: + $ref: "#/definitions/Payment" + "404": + description: "Payment not found" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] + post: + tags: + - "PaymentTransaction" + summary: "Mark a pending payment transaction as succeeded or failed" + description: "" + operationId: "notifyStateChanged" + consumes: + - "application/json" + produces: + - "application/json" + parameters: + - name: "transactionId" + in: "path" + required: true + type: "string" + pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" + format: "uuid" + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/PaymentTransaction" + - name: "controlPluginName" + in: "query" + required: false + type: "array" + items: + type: "string" + collectionFormat: "multi" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "201": + description: "Successfully notifiy state change" + schema: + $ref: "#/definitions/Payment" + "400": + description: "Invalid paymentId supplied" + "404": + description: "Account or Payment not found" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/paymentTransactions/{transactionId}/customFields: get: tags: @@ -11579,165 +11727,7 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/paymentTransactions/{transactionId}: - get: - tags: - - "PaymentTransaction" - summary: "Retrieve a payment by transaction id" - description: "" - operationId: "getPaymentByTransactionId" - produces: - - "application/json" - parameters: - - name: "transactionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - name: "withPluginInfo" - in: "query" - required: false - type: "boolean" - default: false - - name: "withAttempts" - in: "query" - required: false - type: "boolean" - default: false - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: - type: "string" - collectionFormat: "multi" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" - responses: - "200": - description: "successful operation" - schema: - $ref: "#/definitions/Payment" - "404": - description: "Payment not found" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - post: - tags: - - "PaymentTransaction" - summary: "Mark a pending payment transaction as succeeded or failed" - description: "" - operationId: "notifyStateChanged" - consumes: - - "application/json" - produces: - - "application/json" - parameters: - - name: "transactionId" - in: "path" - required: true - type: "string" - pattern: "\\w+-\\w+-\\w+-\\w+-\\w+" - format: "uuid" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/PaymentTransaction" - - name: "controlPluginName" - in: "query" - required: false - type: "array" - items: - type: "string" - collectionFormat: "multi" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "201": - description: "Successfully notifiy state change" - schema: - $ref: "#/definitions/Payment" - "400": - description: "Invalid paymentId supplied" - "404": - description: "Account or Payment not found" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/paymentTransactions: - get: - tags: - - "PaymentTransaction" - summary: "Retrieve a payment by transaction external key" - description: "" - operationId: "getPaymentByTransactionExternalKey" - produces: - - "application/json" - parameters: - - name: "transactionExternalKey" - in: "query" - required: true - type: "string" - - name: "withPluginInfo" - in: "query" - required: false - type: "boolean" - default: false - - name: "withAttempts" - in: "query" - required: false - type: "boolean" - default: false - - name: "pluginProperty" - in: "query" - required: false - type: "array" - items: - type: "string" - collectionFormat: "multi" - - name: "audit" - in: "query" - required: false - type: "string" - default: "NONE" - enum: - - "FULL" - - "MINIMAL" - - "NONE" - responses: - "200": - description: "successful operation" - schema: - $ref: "#/definitions/Payment" - "404": - description: "Payment not found" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] - /1.0/kb/paymentTransactions/{transactionId}/auditLogsWithHistory: + /1.0/kb/paymentTransactions/{transactionId}/auditLogsWithHistory: get: tags: - "PaymentTransaction" @@ -11814,6 +11804,44 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] + /1.0/kb/usages: + post: + tags: + - "Usage" + summary: "Record usage for a subscription" + description: "" + operationId: "recordUsage" + consumes: + - "application/json" + produces: + - "application/json" + parameters: + - in: "body" + name: "body" + required: true + schema: + $ref: "#/definitions/SubscriptionUsageRecord" + - name: "X-Killbill-CreatedBy" + in: "header" + required: true + type: "string" + - name: "X-Killbill-Reason" + in: "header" + required: false + type: "string" + - name: "X-Killbill-Comment" + in: "header" + required: false + type: "string" + responses: + "200": + description: "Successfully recorded usage data change" + "400": + description: "Invalid subscription (e.g. inactive)" + security: + - basicAuth: [] + - Killbill Api Key: [] + - Killbill Api Secret: [] /1.0/kb/usages/{subscriptionId}: get: tags: @@ -11858,44 +11886,6 @@ paths: - basicAuth: [] - Killbill Api Key: [] - Killbill Api Secret: [] - /1.0/kb/usages: - post: - tags: - - "Usage" - summary: "Record usage for a subscription" - description: "" - operationId: "recordUsage" - consumes: - - "application/json" - produces: - - "application/json" - parameters: - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/SubscriptionUsageRecord" - - name: "X-Killbill-CreatedBy" - in: "header" - required: true - type: "string" - - name: "X-Killbill-Reason" - in: "header" - required: false - type: "string" - - name: "X-Killbill-Comment" - in: "header" - required: false - type: "string" - responses: - "200": - description: "Successfully recorded usage data change" - "400": - description: "Invalid subscription (e.g. inactive)" - security: - - basicAuth: [] - - Killbill Api Key: [] - - Killbill Api Secret: [] securityDefinitions: basicAuth: type: "basic" @@ -11908,6 +11898,20 @@ securityDefinitions: name: "X-Killbill-ApiSecret" in: "header" definitions: + AccountEmail: + type: "object" + required: + - "email" + properties: + accountId: + type: "string" + format: "uuid" + email: + type: "string" + auditLogs: + type: "array" + items: + $ref: "#/definitions/AuditLog" AuditLog: type: "object" properties: @@ -11954,38 +11958,33 @@ definitions: Entity: type: "object" properties: + id: + type: "string" + format: "uuid" createdDate: type: "string" format: "date-time" updatedDate: type: "string" format: "date-time" - id: - type: "string" - format: "uuid" - Payment: + Account: type: "object" properties: accountId: type: "string" format: "uuid" - paymentId: + name: type: "string" - format: "uuid" - paymentNumber: + firstNameLength: + type: "integer" + format: "int32" + externalKey: type: "string" - paymentExternalKey: + email: type: "string" - authAmount: - type: "number" - capturedAmount: - type: "number" - purchasedAmount: - type: "number" - refundedAmount: - type: "number" - creditedAmount: - type: "number" + billCycleDayLocal: + type: "integer" + format: "int32" currency: type: "string" enum: @@ -12154,58 +12153,167 @@ definitions: - "ZMW" - "ZWD" - "BTC" + parentAccountId: + type: "string" + format: "uuid" + isPaymentDelegatedToParent: + type: "boolean" paymentMethodId: type: "string" format: "uuid" - transactions: - type: "array" - items: - $ref: "#/definitions/PaymentTransaction" - paymentAttempts: - type: "array" - items: - $ref: "#/definitions/PaymentAttempt" + 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" - PaymentAttempt: + CustomField: type: "object" + required: + - "name" + - "value" properties: - accountId: + customFieldId: type: "string" format: "uuid" - paymentMethodId: + objectId: type: "string" format: "uuid" - paymentExternalKey: + objectType: type: "string" - transactionId: + 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" - transactionExternalKey: + stateName: type: "string" - transactionType: + service: type: "string" - enum: - - "AUTHORIZE" - - "CAPTURE" - - "CHARGEBACK" - - "CREDIT" - - "PURCHASE" - - "REFUND" - - "VOID" + isBlockChange: + type: "boolean" + isBlockEntitlement: + type: "boolean" + isBlockBilling: + type: "boolean" effectiveDate: type: "string" format: "date-time" - stateName: + 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" + Invoice: + type: "object" + properties: amount: type: "number" - description: "Transaction amount, required except for void operations" currency: type: "string" - description: "Amount currency (account currency unless specified)" enum: - "AED" - "AFN" @@ -12372,46 +12480,128 @@ definitions: - "ZMW" - "ZWD" - "BTC" - pluginName: + status: type: "string" - pluginProperties: + enum: + - "DRAFT" + - "COMMITTED" + - "VOID" + creditAdj: + type: "number" + refundAdj: + type: "number" + invoiceId: + type: "string" + format: "uuid" + invoiceDate: + type: "string" + format: "date" + targetDate: + type: "string" + format: "date" + invoiceNumber: + type: "string" + balance: + type: "number" + accountId: + type: "string" + format: "uuid" + bundleKeys: + type: "string" + credits: type: "array" items: - $ref: "#/definitions/PluginProperty" + $ref: "#/definitions/InvoiceItem" + items: + type: "array" + items: + $ref: "#/definitions/InvoiceItem" + trackingIds: + type: "array" + items: + type: "string" + isParentInvoice: + type: "boolean" + parentInvoiceId: + type: "string" + format: "uuid" + parentAccountId: + type: "string" + format: "uuid" auditLogs: type: "array" items: $ref: "#/definitions/AuditLog" - PaymentTransaction: + InvoiceItem: type: "object" + required: + - "accountId" + - "invoiceItemId" properties: - transactionId: + invoiceItemId: type: "string" format: "uuid" - transactionExternalKey: + invoiceId: type: "string" - paymentId: + format: "uuid" + linkedInvoiceItemId: type: "string" format: "uuid" - description: "Associated payment id, required when notifying state transitions" - paymentExternalKey: + accountId: type: "string" - transactionType: + format: "uuid" + childAccountId: type: "string" - enum: - - "AUTHORIZE" - - "CAPTURE" - - "CHARGEBACK" - - "CREDIT" - - "PURCHASE" - - "REFUND" - - "VOID" + format: "uuid" + bundleId: + type: "string" + format: "uuid" + subscriptionId: + type: "string" + format: "uuid" + productName: + type: "string" + planName: + type: "string" + phaseName: + type: "string" + usageName: + type: "string" + prettyProductName: + type: "string" + prettyPlanName: + type: "string" + prettyPhaseName: + type: "string" + prettyUsageName: + type: "string" + itemType: + type: "string" + enum: + - "EXTERNAL_CHARGE" + - "FIXED" + - "RECURRING" + - "REPAIR_ADJ" + - "CBA_ADJ" + - "CREDIT_ADJ" + - "ITEM_ADJ" + - "USAGE" + - "TAX" + - "PARENT_SUMMARY" + description: + type: "string" + startDate: + type: "string" + format: "date" + endDate: + type: "string" + format: "date" amount: type: "number" - description: "Transaction amount, required except for void operations" + rate: + type: "number" currency: type: "string" - description: "Amount currency (account currency unless specified)" enum: - "AED" - "AFN" @@ -12578,12 +12768,45 @@ definitions: - "ZMW" - "ZWD" - "BTC" - effectiveDate: + quantity: + type: "number" + itemDetails: + type: "string" + catalogEffectiveDate: type: "string" format: "date-time" - processedAmount: + childItems: + type: "array" + items: + $ref: "#/definitions/InvoiceItem" + auditLogs: + type: "array" + items: + $ref: "#/definitions/AuditLog" + Payment: + type: "object" + properties: + 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" @@ -12751,180 +12974,58 @@ 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" - CustomField: + PaymentAttempt: type: "object" - required: - - "name" - - "value" properties: - customFieldId: + accountId: type: "string" format: "uuid" - objectId: + paymentMethodId: 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: + paymentExternalKey: type: "string" - auditLogs: - type: "array" - items: - $ref: "#/definitions/AuditLog" - BlockingState: - type: "object" - properties: - blockedId: + transactionId: type: "string" format: "uuid" - stateName: + transactionExternalKey: type: "string" - service: + transactionType: type: "string" - isBlockChange: - type: "boolean" - isBlockEntitlement: - type: "boolean" - isBlockBilling: - type: "boolean" + enum: + - "AUTHORIZE" + - "CAPTURE" + - "CHARGEBACK" + - "CREDIT" + - "PURCHASE" + - "REFUND" + - "VOID" effectiveDate: type: "string" format: "date-time" - type: - type: "string" - enum: - - "SUBSCRIPTION" - - "SUBSCRIPTION_BUNDLE" - - "ACCOUNT" - auditLogs: - type: "array" - items: - $ref: "#/definitions/AuditLog" - Tag: - type: "object" - properties: - tagId: + stateName: 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" - capturedAmount: - type: "number" - purchasedAmount: - type: "number" - refundedAmount: - type: "number" - creditedAmount: - type: "number" - currency: + amount: + type: "number" + description: "Transaction amount, required except for void operations" + currency: type: "string" + description: "Amount currency (account currency unless specified)" enum: - "AED" - "AFN" @@ -13091,41 +13192,46 @@ 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" - Account: + PaymentTransaction: type: "object" properties: - accountId: + transactionId: type: "string" format: "uuid" - name: + transactionExternalKey: type: "string" - firstNameLength: - type: "integer" - format: "int32" - externalKey: + paymentId: type: "string" - email: + format: "uuid" + description: "Associated payment id, required when notifying state transitions" + paymentExternalKey: type: "string" - billCycleDayLocal: - type: "integer" - format: "int32" + transactionType: + type: "string" + enum: + - "AUTHORIZE" + - "CAPTURE" + - "CHARGEBACK" + - "CREDIT" + - "PURCHASE" + - "REFUND" + - "VOID" + amount: + type: "number" + description: "Transaction amount, required except for void operations" currency: type: "string" + description: "Amount currency (account currency unless specified)" enum: - "AED" - "AFN" @@ -13292,49 +13398,246 @@ definitions: - "ZMW" - "ZWD" - "BTC" - parentAccountId: - type: "string" - format: "uuid" - isPaymentDelegatedToParent: - type: "boolean" - paymentMethodId: - type: "string" - format: "uuid" - referenceTime: + effectiveDate: type: "string" format: "date-time" - timeZone: - type: "string" - address1: + processedAmount: + type: "number" + processedCurrency: type: "string" - address2: + enum: + - "AED" + - "AFN" + - "ALL" + - "AMD" + - "ANG" + - "AOA" + - "ARS" + - "AUD" + - "AWG" + - "AZN" + - "BAM" + - "BBD" + - "BDT" + - "BGN" + - "BHD" + - "BIF" + - "BMD" + - "BND" + - "BOB" + - "BRL" + - "BSD" + - "BTN" + - "BWP" + - "BYR" + - "BZD" + - "CAD" + - "CDF" + - "CHF" + - "CLP" + - "CNY" + - "COP" + - "CRC" + - "CUC" + - "CUP" + - "CVE" + - "CZK" + - "DJF" + - "DKK" + - "DOP" + - "DZD" + - "EGP" + - "ERN" + - "ETB" + - "EUR" + - "FJD" + - "FKP" + - "GBP" + - "GEL" + - "GGP" + - "GHS" + - "GIP" + - "GMD" + - "GNF" + - "GTQ" + - "GYD" + - "HKD" + - "HNL" + - "HRK" + - "HTG" + - "HUF" + - "IDR" + - "ILS" + - "IMP" + - "INR" + - "IQD" + - "IRR" + - "ISK" + - "JEP" + - "JMD" + - "JOD" + - "JPY" + - "KES" + - "KGS" + - "KHR" + - "KMF" + - "KPW" + - "KRW" + - "KWD" + - "KYD" + - "KZT" + - "LAK" + - "LBP" + - "LKR" + - "LRD" + - "LSL" + - "LTL" + - "LVL" + - "LYD" + - "MAD" + - "MDL" + - "MGA" + - "MKD" + - "MMK" + - "MNT" + - "MOP" + - "MRO" + - "MUR" + - "MVR" + - "MWK" + - "MXN" + - "MYR" + - "MZN" + - "NAD" + - "NGN" + - "NIO" + - "NOK" + - "NPR" + - "NZD" + - "OMR" + - "PAB" + - "PEN" + - "PGK" + - "PHP" + - "PKR" + - "PLN" + - "PYG" + - "QAR" + - "RON" + - "RSD" + - "RUB" + - "RWF" + - "SAR" + - "SBD" + - "SCR" + - "SDG" + - "SEK" + - "SGD" + - "SHP" + - "SLL" + - "SOS" + - "SPL" + - "SRD" + - "STD" + - "SVC" + - "SYP" + - "SZL" + - "THB" + - "TJS" + - "TMT" + - "TND" + - "TOP" + - "TRY" + - "TTD" + - "TVD" + - "TWD" + - "TZS" + - "UAH" + - "UGX" + - "USD" + - "UYU" + - "UZS" + - "VEF" + - "VND" + - "VUV" + - "WST" + - "XAF" + - "XCD" + - "XDR" + - "XOF" + - "XPF" + - "YER" + - "ZAR" + - "ZMW" + - "ZWD" + - "BTC" + status: type: "string" - postalCode: + description: "Transaction status, required for state change notifications" + enum: + - "SUCCESS" + - "UNKNOWN" + - "PENDING" + - "PAYMENT_FAILURE" + - "PLUGIN_FAILURE" + - "PAYMENT_SYSTEM_OFF" + gatewayErrorCode: type: "string" - company: + gatewayErrorMsg: type: "string" - city: + firstPaymentReferenceId: type: "string" - state: + secondPaymentReferenceId: type: "string" - country: + properties: + type: "array" + items: + $ref: "#/definitions/PluginProperty" + auditLogs: + type: "array" + items: + $ref: "#/definitions/AuditLog" + PluginProperty: + type: "object" + properties: + key: type: "string" - locale: + value: type: "string" - phone: + isUpdatable: + type: "boolean" + PaymentMethod: + type: "object" + properties: + paymentMethodId: type: "string" - notes: + format: "uuid" + externalKey: type: "string" - isMigrated: + accountId: + type: "string" + format: "uuid" + isDefault: type: "boolean" - accountBalance: - type: "number" - accountCBA: - type: "number" + pluginName: + type: "string" + pluginInfo: + $ref: "#/definitions/PaymentMethodPluginDetail" auditLogs: type: "array" items: $ref: "#/definitions/AuditLog" + PaymentMethodPluginDetail: + type: "object" + properties: + externalPaymentMethodId: + type: "string" + isDefaultPaymentMethod: + type: "boolean" + properties: + type: "array" + items: + $ref: "#/definitions/PluginProperty" BlockPrice: type: "object" properties: @@ -13613,298 +13916,64 @@ definitions: type: "array" items: $ref: "#/definitions/TierPrice" - Invoice: + OverdueState: type: "object" properties: - amount: - type: "number" - currency: - type: "string" - enum: - - "AED" - - "AFN" - - "ALL" - - "AMD" - - "ANG" - - "AOA" - - "ARS" - - "AUD" - - "AWG" - - "AZN" - - "BAM" - - "BBD" - - "BDT" - - "BGN" - - "BHD" - - "BIF" - - "BMD" - - "BND" - - "BOB" - - "BRL" - - "BSD" - - "BTN" - - "BWP" - - "BYR" - - "BZD" - - "CAD" - - "CDF" - - "CHF" - - "CLP" - - "CNY" - - "COP" - - "CRC" - - "CUC" - - "CUP" - - "CVE" - - "CZK" - - "DJF" - - "DKK" - - "DOP" - - "DZD" - - "EGP" - - "ERN" - - "ETB" - - "EUR" - - "FJD" - - "FKP" - - "GBP" - - "GEL" - - "GGP" - - "GHS" - - "GIP" - - "GMD" - - "GNF" - - "GTQ" - - "GYD" - - "HKD" - - "HNL" - - "HRK" - - "HTG" - - "HUF" - - "IDR" - - "ILS" - - "IMP" - - "INR" - - "IQD" - - "IRR" - - "ISK" - - "JEP" - - "JMD" - - "JOD" - - "JPY" - - "KES" - - "KGS" - - "KHR" - - "KMF" - - "KPW" - - "KRW" - - "KWD" - - "KYD" - - "KZT" - - "LAK" - - "LBP" - - "LKR" - - "LRD" - - "LSL" - - "LTL" - - "LVL" - - "LYD" - - "MAD" - - "MDL" - - "MGA" - - "MKD" - - "MMK" - - "MNT" - - "MOP" - - "MRO" - - "MUR" - - "MVR" - - "MWK" - - "MXN" - - "MYR" - - "MZN" - - "NAD" - - "NGN" - - "NIO" - - "NOK" - - "NPR" - - "NZD" - - "OMR" - - "PAB" - - "PEN" - - "PGK" - - "PHP" - - "PKR" - - "PLN" - - "PYG" - - "QAR" - - "RON" - - "RSD" - - "RUB" - - "RWF" - - "SAR" - - "SBD" - - "SCR" - - "SDG" - - "SEK" - - "SGD" - - "SHP" - - "SLL" - - "SOS" - - "SPL" - - "SRD" - - "STD" - - "SVC" - - "SYP" - - "SZL" - - "THB" - - "TJS" - - "TMT" - - "TND" - - "TOP" - - "TRY" - - "TTD" - - "TVD" - - "TWD" - - "TZS" - - "UAH" - - "UGX" - - "USD" - - "UYU" - - "UZS" - - "VEF" - - "VND" - - "VUV" - - "WST" - - "XAF" - - "XCD" - - "XDR" - - "XOF" - - "XPF" - - "YER" - - "ZAR" - - "ZMW" - - "ZWD" - - "BTC" - status: - type: "string" - enum: - - "DRAFT" - - "COMMITTED" - - "VOID" - creditAdj: - type: "number" - refundAdj: - type: "number" - invoiceId: - type: "string" - format: "uuid" - invoiceDate: - type: "string" - format: "date" - targetDate: - type: "string" - format: "date" - invoiceNumber: - type: "string" - balance: - type: "number" - accountId: + name: type: "string" - format: "uuid" - bundleKeys: + externalMessage: type: "string" - credits: - type: "array" - items: - $ref: "#/definitions/InvoiceItem" - items: + isDisableEntitlementAndChangesBlocked: + type: "boolean" + isBlockChanges: + type: "boolean" + isClearState: + type: "boolean" + reevaluationIntervalDays: + type: "integer" + format: "int32" + AccountTimeline: + type: "object" + properties: + account: + $ref: "#/definitions/Account" + bundles: type: "array" items: - $ref: "#/definitions/InvoiceItem" - trackingIds: + $ref: "#/definitions/Bundle" + invoices: type: "array" items: - type: "string" - isParentInvoice: - type: "boolean" - parentInvoiceId: - type: "string" - format: "uuid" - parentAccountId: - type: "string" - format: "uuid" - auditLogs: + $ref: "#/definitions/Invoice" + payments: type: "array" items: - $ref: "#/definitions/AuditLog" - InvoiceItem: + $ref: "#/definitions/InvoicePayment" + InvoicePayment: type: "object" - required: - - "accountId" - - "invoiceItemId" properties: - invoiceItemId: - type: "string" - format: "uuid" - invoiceId: - type: "string" - format: "uuid" - linkedInvoiceItemId: - type: "string" - format: "uuid" - accountId: - type: "string" - format: "uuid" - childAccountId: - type: "string" - format: "uuid" - bundleId: - type: "string" - format: "uuid" - subscriptionId: - type: "string" - format: "uuid" - productName: - type: "string" - planName: - type: "string" - phaseName: - type: "string" - usageName: - type: "string" - prettyProductName: - type: "string" - prettyPlanName: - type: "string" - prettyPhaseName: - type: "string" - prettyUsageName: - type: "string" - itemType: - type: "string" - enum: - - "EXTERNAL_CHARGE" - - "FIXED" - - "RECURRING" - - "REPAIR_ADJ" - - "CBA_ADJ" - - "CREDIT_ADJ" - - "ITEM_ADJ" - - "USAGE" - - "TAX" - - "PARENT_SUMMARY" - description: + targetInvoiceId: type: "string" - startDate: + format: "uuid" + accountId: type: "string" - format: "date" - endDate: + format: "uuid" + paymentId: type: "string" - format: "date" - amount: + format: "uuid" + paymentNumber: + type: "string" + paymentExternalKey: + type: "string" + authAmount: type: "number" - rate: + capturedAmount: + type: "number" + purchasedAmount: + type: "number" + refundedAmount: + type: "number" + creditedAmount: type: "number" currency: type: "string" @@ -14074,119 +14143,94 @@ definitions: - "ZMW" - "ZWD" - "BTC" - quantity: - type: "number" - itemDetails: - type: "string" - catalogEffectiveDate: + paymentMethodId: type: "string" - format: "date-time" - childItems: + format: "uuid" + transactions: type: "array" items: - $ref: "#/definitions/InvoiceItem" + $ref: "#/definitions/PaymentTransaction" + paymentAttempts: + type: "array" + items: + $ref: "#/definitions/PaymentAttempt" auditLogs: type: "array" items: $ref: "#/definitions/AuditLog" - OverdueState: + AdminPayment: type: "object" properties: - name: + lastSuccessPaymentState: type: "string" - externalMessage: + currentPaymentStateName: type: "string" - isDisableEntitlementAndChangesBlocked: - type: "boolean" - isBlockChanges: - type: "boolean" - isClearState: - type: "boolean" - reevaluationIntervalDays: - type: "integer" - format: "int32" - AccountTimeline: + transactionStatus: + type: "string" + PriceList: type: "object" properties: - account: - $ref: "#/definitions/Account" - bundles: - type: "array" - items: - $ref: "#/definitions/Bundle" - invoices: - type: "array" - items: - $ref: "#/definitions/Invoice" - payments: + name: + type: "string" + plans: type: "array" items: - $ref: "#/definitions/InvoicePayment" - AccountEmail: + type: "string" + Duration: type: "object" - required: - - "email" properties: - accountId: - type: "string" - format: "uuid" - email: + unit: type: "string" - auditLogs: - type: "array" - items: - $ref: "#/definitions/AuditLog" - PaymentMethod: + enum: + - "DAYS" + - "WEEKS" + - "MONTHS" + - "YEARS" + - "UNLIMITED" + number: + type: "integer" + format: "int32" + Limit: type: "object" properties: - paymentMethodId: - type: "string" - format: "uuid" - externalKey: + unit: type: "string" - accountId: + max: type: "string" - format: "uuid" - isDefault: - type: "boolean" - pluginName: + min: type: "string" - pluginInfo: - $ref: "#/definitions/PaymentMethodPluginDetail" - auditLogs: - type: "array" - items: - $ref: "#/definitions/AuditLog" - PaymentMethodPluginDetail: + Phase: type: "object" properties: - externalPaymentMethodId: + type: type: "string" - isDefaultPaymentMethod: - type: "boolean" - properties: + prices: type: "array" items: - $ref: "#/definitions/PluginProperty" - AdminPayment: - type: "object" - properties: - lastSuccessPaymentState: - type: "string" - currentPaymentStateName: - type: "string" - transactionStatus: - type: "string" - PlanDetail: + $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: - product: + name: type: "string" - plan: + prettyName: type: "string" - priceList: + recurringBillingMode: type: "string" - finalPhaseBillingPeriod: + enum: + - "IN_ADVANCE" + - "IN_ARREAR" + billingPeriod: type: "string" enum: - "DAILY" @@ -14206,10 +14250,10 @@ definitions: - "BIENNIAL" - "TRIENNIAL" - "NO_BILLING_PERIOD" - finalPhaseRecurringPrice: + phases: type: "array" items: - $ref: "#/definitions/Price" + $ref: "#/definitions/Phase" Price: type: "object" properties: @@ -14383,70 +14427,78 @@ definitions: - "BTC" value: type: "number" - PriceList: + 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" - Duration: + available: + type: "array" + items: + type: "string" + Tier: type: "object" properties: - unit: - type: "string" - enum: - - "DAYS" - - "WEEKS" - - "MONTHS" - - "YEARS" - - "UNLIMITED" - number: - type: "integer" - format: "int32" - Limit: + 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" - max: - type: "string" - min: + size: type: "string" - Phase: - type: "object" - properties: - type: + max: type: "string" prices: type: "array" items: $ref: "#/definitions/Price" - fixedPrices: - type: "array" - items: - $ref: "#/definitions/Price" - duration: - $ref: "#/definitions/Duration" - usages: + Usage: + type: "object" + properties: + billingPeriod: + type: "string" + tiers: type: "array" items: - $ref: "#/definitions/Usage" - Plan: + $ref: "#/definitions/Tier" + PlanDetail: type: "object" properties: - name: + product: type: "string" - prettyName: + plan: type: "string" - recurringBillingMode: + priceList: type: "string" - enum: - - "IN_ADVANCE" - - "IN_ARREAR" - billingPeriod: + finalPhaseBillingPeriod: type: "string" enum: - "DAILY" @@ -14466,72 +14518,219 @@ definitions: - "BIENNIAL" - "TRIENNIAL" - "NO_BILLING_PERIOD" - phases: + finalPhaseRecurringPrice: type: "array" items: - $ref: "#/definitions/Phase" - Product: + $ref: "#/definitions/Price" + CatalogValidation: + type: "object" + properties: + catalogValidationErrors: + type: "array" + items: + $ref: "#/definitions/CatalogValidationError" + CatalogValidationError: type: "object" properties: - type: + errorDescription: type: "string" + Catalog: + type: "object" + properties: name: type: "string" - prettyName: + effectiveDate: type: "string" - plans: - type: "array" - items: - $ref: "#/definitions/Plan" - included: - type: "array" - items: - type: "string" - available: + format: "date-time" + currencies: type: "array" items: type: "string" - Tier: - type: "object" - properties: - limits: - type: "array" - items: - $ref: "#/definitions/Limit" - fixedPrice: + enum: + - "AED" + - "AFN" + - "ALL" + - "AMD" + - "ANG" + - "AOA" + - "ARS" + - "AUD" + - "AWG" + - "AZN" + - "BAM" + - "BBD" + - "BDT" + - "BGN" + - "BHD" + - "BIF" + - "BMD" + - "BND" + - "BOB" + - "BRL" + - "BSD" + - "BTN" + - "BWP" + - "BYR" + - "BZD" + - "CAD" + - "CDF" + - "CHF" + - "CLP" + - "CNY" + - "COP" + - "CRC" + - "CUC" + - "CUP" + - "CVE" + - "CZK" + - "DJF" + - "DKK" + - "DOP" + - "DZD" + - "EGP" + - "ERN" + - "ETB" + - "EUR" + - "FJD" + - "FKP" + - "GBP" + - "GEL" + - "GGP" + - "GHS" + - "GIP" + - "GMD" + - "GNF" + - "GTQ" + - "GYD" + - "HKD" + - "HNL" + - "HRK" + - "HTG" + - "HUF" + - "IDR" + - "ILS" + - "IMP" + - "INR" + - "IQD" + - "IRR" + - "ISK" + - "JEP" + - "JMD" + - "JOD" + - "JPY" + - "KES" + - "KGS" + - "KHR" + - "KMF" + - "KPW" + - "KRW" + - "KWD" + - "KYD" + - "KZT" + - "LAK" + - "LBP" + - "LKR" + - "LRD" + - "LSL" + - "LTL" + - "LVL" + - "LYD" + - "MAD" + - "MDL" + - "MGA" + - "MKD" + - "MMK" + - "MNT" + - "MOP" + - "MRO" + - "MUR" + - "MVR" + - "MWK" + - "MXN" + - "MYR" + - "MZN" + - "NAD" + - "NGN" + - "NIO" + - "NOK" + - "NPR" + - "NZD" + - "OMR" + - "PAB" + - "PEN" + - "PGK" + - "PHP" + - "PKR" + - "PLN" + - "PYG" + - "QAR" + - "RON" + - "RSD" + - "RUB" + - "RWF" + - "SAR" + - "SBD" + - "SCR" + - "SDG" + - "SEK" + - "SGD" + - "SHP" + - "SLL" + - "SOS" + - "SPL" + - "SRD" + - "STD" + - "SVC" + - "SYP" + - "SZL" + - "THB" + - "TJS" + - "TMT" + - "TND" + - "TOP" + - "TRY" + - "TTD" + - "TVD" + - "TWD" + - "TZS" + - "UAH" + - "UGX" + - "USD" + - "UYU" + - "UZS" + - "VEF" + - "VND" + - "VUV" + - "WST" + - "XAF" + - "XCD" + - "XDR" + - "XOF" + - "XPF" + - "YER" + - "ZAR" + - "ZMW" + - "ZWD" + - "BTC" + units: type: "array" items: - $ref: "#/definitions/Price" - recurringPrice: + $ref: "#/definitions/Unit" + products: type: "array" items: - $ref: "#/definitions/Price" - blocks: + $ref: "#/definitions/Product" + priceLists: type: "array" items: - $ref: "#/definitions/TieredBlock" - TieredBlock: + $ref: "#/definitions/PriceList" + Unit: type: "object" properties: - unit: - type: "string" - size: - type: "string" - max: + name: type: "string" - prices: - type: "array" - items: - $ref: "#/definitions/Price" - Usage: - type: "object" - properties: - billingPeriod: + prettyName: type: "string" - tiers: - type: "array" - items: - $ref: "#/definitions/Tier" SimplePlan: type: "object" properties: @@ -14740,225 +14939,16 @@ definitions: format: "int32" trialTimeUnit: type: "string" - enum: - - "DAYS" - - "WEEKS" - - "MONTHS" - - "YEARS" - - "UNLIMITED" - availableBaseProducts: - type: "array" - items: - type: "string" - CatalogValidation: - type: "object" - properties: - catalogValidationErrors: - type: "array" - items: - $ref: "#/definitions/CatalogValidationError" - CatalogValidationError: - type: "object" - properties: - errorDescription: - type: "string" - Catalog: - type: "object" - properties: - name: - type: "string" - effectiveDate: - type: "string" - format: "date-time" - currencies: + enum: + - "DAYS" + - "WEEKS" + - "MONTHS" + - "YEARS" + - "UNLIMITED" + availableBaseProducts: type: "array" items: type: "string" - enum: - - "AED" - - "AFN" - - "ALL" - - "AMD" - - "ANG" - - "AOA" - - "ARS" - - "AUD" - - "AWG" - - "AZN" - - "BAM" - - "BBD" - - "BDT" - - "BGN" - - "BHD" - - "BIF" - - "BMD" - - "BND" - - "BOB" - - "BRL" - - "BSD" - - "BTN" - - "BWP" - - "BYR" - - "BZD" - - "CAD" - - "CDF" - - "CHF" - - "CLP" - - "CNY" - - "COP" - - "CRC" - - "CUC" - - "CUP" - - "CVE" - - "CZK" - - "DJF" - - "DKK" - - "DOP" - - "DZD" - - "EGP" - - "ERN" - - "ETB" - - "EUR" - - "FJD" - - "FKP" - - "GBP" - - "GEL" - - "GGP" - - "GHS" - - "GIP" - - "GMD" - - "GNF" - - "GTQ" - - "GYD" - - "HKD" - - "HNL" - - "HRK" - - "HTG" - - "HUF" - - "IDR" - - "ILS" - - "IMP" - - "INR" - - "IQD" - - "IRR" - - "ISK" - - "JEP" - - "JMD" - - "JOD" - - "JPY" - - "KES" - - "KGS" - - "KHR" - - "KMF" - - "KPW" - - "KRW" - - "KWD" - - "KYD" - - "KZT" - - "LAK" - - "LBP" - - "LKR" - - "LRD" - - "LSL" - - "LTL" - - "LVL" - - "LYD" - - "MAD" - - "MDL" - - "MGA" - - "MKD" - - "MMK" - - "MNT" - - "MOP" - - "MRO" - - "MUR" - - "MVR" - - "MWK" - - "MXN" - - "MYR" - - "MZN" - - "NAD" - - "NGN" - - "NIO" - - "NOK" - - "NPR" - - "NZD" - - "OMR" - - "PAB" - - "PEN" - - "PGK" - - "PHP" - - "PKR" - - "PLN" - - "PYG" - - "QAR" - - "RON" - - "RSD" - - "RUB" - - "RWF" - - "SAR" - - "SBD" - - "SCR" - - "SDG" - - "SEK" - - "SGD" - - "SHP" - - "SLL" - - "SOS" - - "SPL" - - "SRD" - - "STD" - - "SVC" - - "SYP" - - "SZL" - - "THB" - - "TJS" - - "TMT" - - "TND" - - "TOP" - - "TRY" - - "TTD" - - "TVD" - - "TWD" - - "TZS" - - "UAH" - - "UGX" - - "USD" - - "UYU" - - "UZS" - - "VEF" - - "VND" - - "VUV" - - "WST" - - "XAF" - - "XCD" - - "XDR" - - "XOF" - - "XPF" - - "YER" - - "ZAR" - - "ZMW" - - "ZWD" - - "BTC" - units: - type: "array" - items: - $ref: "#/definitions/Unit" - products: - type: "array" - items: - $ref: "#/definitions/Product" - priceLists: - type: "array" - items: - $ref: "#/definitions/PriceList" - Unit: - type: "object" - properties: - name: - type: "string" - prettyName: - type: "string" InvoicePaymentTransaction: type: "object" properties: @@ -15617,6 +15607,13 @@ definitions: type: "array" items: $ref: "#/definitions/AuditLog" + HostedPaymentPageFields: + type: "object" + properties: + formFields: + type: "array" + items: + $ref: "#/definitions/PluginProperty" ComboHostedPaymentPage: type: "object" properties: @@ -15634,13 +15631,6 @@ definitions: type: "array" items: $ref: "#/definitions/AuditLog" - HostedPaymentPageFields: - type: "object" - properties: - formFields: - type: "array" - items: - $ref: "#/definitions/PluginProperty" ComboPaymentTransaction: type: "object" properties: @@ -15662,6 +15652,18 @@ definitions: type: "array" items: $ref: "#/definitions/AuditLog" + RoleDefinition: + type: "object" + required: + - "permissions" + - "role" + properties: + role: + type: "string" + permissions: + type: "array" + items: + type: "string" Session: type: "object" properties: @@ -15704,18 +15706,6 @@ definitions: 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: @@ -15769,6 +15759,19 @@ definitions: type: "array" items: $ref: "#/definitions/AuditLog" + TenantKeyValue: + type: "object" + properties: + key: + type: "string" + values: + type: "array" + items: + type: "string" + auditLogs: + type: "array" + items: + $ref: "#/definitions/AuditLog" Tenant: type: "object" required: @@ -15788,19 +15791,6 @@ definitions: type: "array" items: $ref: "#/definitions/AuditLog" - TenantKeyValue: - type: "object" - properties: - key: - type: "string" - values: - type: "array" - items: - type: "string" - auditLogs: - type: "array" - items: - $ref: "#/definitions/AuditLog" RolledUpUnit: type: "object" properties: 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 4d7b919..a85e905 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,20 +602,11 @@ 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(); @@ -820,10 +811,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), Boolean.valueOf(false), inputOptions); + return uploadInvoiceTemplate(body, Boolean.valueOf(false), inputOptions); } - public String uploadInvoiceTemplate(final String body, final Boolean deleteIfExists, final Boolean templateWithBrandInfo, final RequestOptions inputOptions) throws KillBillClientException { + public String uploadInvoiceTemplate(final String body, final Boolean deleteIfExists, final RequestOptions inputOptions) throws KillBillClientException { Preconditions.checkNotNull(body, "Missing the required parameter 'body' when calling uploadInvoiceTemplate"); final String uri = "/1.0/kb/invoices/template"; @@ -832,9 +823,6 @@ 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);