diff --git a/.swagger-codegen/KB_VERSION b/.swagger-codegen/KB_VERSION
index 325720e..0676343 100644
--- a/.swagger-codegen/KB_VERSION
+++ b/.swagger-codegen/KB_VERSION
@@ -1,4 +1,4 @@
swaggerVersion=2.4.1
-kbVersion=0.24.19-SNAPSHOT
-kbApiVersion=0.54.0
-kbPluginApiVersion=0.27.3
+kbVersion=0.25.4-SNAPSHOT
+kbApiVersion=0.55.1
+kbPluginApiVersion=0.28.1
diff --git a/.swagger-codegen/kbswagger.yaml b/.swagger-codegen/kbswagger.yaml
index 84939dc..55bc0ea 100644
--- a/.swagger-codegen/kbswagger.yaml
+++ b/.swagger-codegen/kbswagger.yaml
@@ -1,14 +1,13 @@
----
swagger: "2.0"
info:
- description: "Kill Bill is an open-source billing and payments platform"
- version: "0.24.19-SNAPSHOT"
title: "Kill Bill"
+ description: "Kill Bill is an open-source billing and payments platform"
contact:
name: "killbilling-users@googlegroups.com"
license:
name: "Apache License, Version 2.0"
url: "http://www.apache.org/licenses/LICENSE-2.0.html"
+ version: "0.25.4-SNAPSHOT"
tags:
- name: "Account"
- name: "Admin"
@@ -33,28 +32,49 @@ tags:
- name: "Tenant"
- name: "PaymentTransaction"
- name: "Usage"
+securityDefinitions:
+ basicAuth:
+ type: "basic"
+ Killbill Api Key:
+ type: "apiKey"
+ name: "X-Killbill-ApiKey"
+ in: "header"
+ Killbill Api Secret:
+ type: "apiKey"
+ name: "X-Killbill-ApiSecret"
+ in: "header"
paths:
- /1.0/kb/accounts/{accountId}/tags:
+ /1.0/kb/accounts/{accountId}/block:
get:
tags:
- "Account"
- summary: "Retrieve account tags"
- description: ""
- operationId: "getAccountTags"
- produces:
- - "application/json"
+ summary: "Retrieve blocking states for account"
+ operationId: "getBlockingStates"
parameters:
- name: "accountId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "includedDeleted"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "blockingStateTypes"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ enum:
+ - "SUBSCRIPTION"
+ - "SUBSCRIPTION_BUNDLE"
+ - "ACCOUNT"
+ collectionFormat: "multi"
+ required: false
+ - name: "blockingStateSvcs"
in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
required: false
- type: "boolean"
- default: false
- name: "audit"
in: "query"
required: false
@@ -70,443 +90,304 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/Tag"
+ $ref: "#/definitions/BlockingState"
"400":
description: "Invalid account id supplied"
- "404":
- description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
post:
tags:
- "Account"
- summary: "Add tags to account"
- description: ""
- operationId: "createAccountTags"
- consumes:
- - "application/json"
- produces:
- - "application/json"
+ summary: "Block an account"
+ operationId: "addAccountBlockingState"
parameters:
- name: "accountId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
schema:
- type: "array"
- items:
- type: "string"
- format: "uuid"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
+ $ref: "#/definitions/BlockingState"
+ - name: "requestedDate"
+ in: "query"
type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
+ format: "date"
required: false
- type: "string"
- responses:
- "201":
- description: "Tag created successfully"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/Tag"
- "400":
- description: "Invalid account id supplied"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- delete:
- tags:
- - "Account"
- summary: "Remove tags from account"
- description: ""
- operationId: "deleteAccountTags"
- consumes:
- - "application/json"
- produces:
- - "application/json"
- parameters:
- - name: "accountId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "tagDef"
+ - name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
- format: "uuid"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
- "204":
- description: "Successful operation"
+ "201":
+ description: "Blocking state created successfully"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/BlockingState"
"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"
+ "404":
+ description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/customFields:
+ consumes:
+ - "application/json"
+ /1.0/kb/accounts/{accountId}/emails:
get:
tags:
- "Account"
- summary: "Retrieve account custom fields"
- description: ""
- operationId: "getAccountCustomFields"
- produces:
- - "application/json"
+ summary: "Retrieve an account emails"
+ operationId: "getEmails"
parameters:
- name: "accountId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "audit"
- in: "query"
- required: false
- type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
responses:
"200":
description: "successful operation"
schema:
type: "array"
items:
- $ref: "#/definitions/CustomField"
+ $ref: "#/definitions/AccountEmail"
"400":
description: "Invalid account id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
post:
tags:
- "Account"
- summary: "Add custom fields to account"
- description: ""
- operationId: "createAccountCustomFields"
- consumes:
- - "application/json"
- produces:
- - "application/json"
+ summary: "Add account email"
+ operationId: "addEmail"
parameters:
- name: "accountId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
schema:
- type: "array"
- items:
- $ref: "#/definitions/CustomField"
+ $ref: "#/definitions/AccountEmail"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
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:
- tags:
- - "Account"
- summary: "Modify custom fields to account"
- description: ""
- operationId: "modifyAccountCustomFields"
+ produces:
+ - "application/json"
consumes:
- "application/json"
+ /1.0/kb/accounts/{accountId}:
+ get:
+ tags:
+ - "Account"
+ summary: "Retrieve an account by id"
+ operationId: "getAccount"
+ parameters:
+ - name: "accountId"
+ in: "path"
+ required: true
+ type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "accountWithBalance"
+ in: "query"
+ type: "boolean"
+ default: false
+ required: false
+ - name: "accountWithBalanceAndCBA"
+ in: "query"
+ type: "boolean"
+ default: false
+ required: false
+ - name: "audit"
+ in: "query"
+ required: false
+ type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ $ref: "#/definitions/Account"
+ "400":
+ description: "Invalid account id supplied"
+ "404":
+ description: "Account not found"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
produces:
- "application/json"
+ put:
+ tags:
+ - "Account"
+ summary: "Update account"
+ operationId: "updateAccount"
parameters:
- name: "accountId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
schema:
- type: "array"
- items:
- $ref: "#/definitions/CustomField"
+ $ref: "#/definitions/Account"
+ - name: "treatNullAsReset"
+ in: "query"
+ type: "boolean"
+ default: false
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"204":
description: "Successful operation"
"400":
- description: "Invalid account id supplied"
+ description: "Invalid account data supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
delete:
tags:
- "Account"
- summary: "Remove custom fields from account"
- description: ""
- operationId: "deleteAccountCustomFields"
- consumes:
- - "application/json"
- produces:
- - "application/json"
+ summary: "Close account"
+ operationId: "closeAccount"
parameters:
- name: "accountId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "customField"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- format: "uuid"
- collectionFormat: "multi"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
- responses:
- "204":
- description: "Successful operation"
- "400":
- description: "Invalid account id supplied"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/block:
- get:
- tags:
- - "Account"
- summary: "Retrieve blocking states for account"
- description: ""
- operationId: "getBlockingStates"
- produces:
- - "application/json"
- parameters:
- - name: "accountId"
- in: "path"
- required: true
- type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "blockingStateTypes"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- enum:
- - "SUBSCRIPTION"
- - "SUBSCRIPTION_BUNDLE"
- - "ACCOUNT"
- collectionFormat: "multi"
- - name: "blockingStateSvcs"
+ - name: "cancelAllSubscriptions"
in: "query"
+ type: "boolean"
+ default: false
required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "audit"
+ - name: "writeOffUnpaidInvoices"
in: "query"
+ type: "boolean"
+ default: false
required: false
- type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
- responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/BlockingState"
- "400":
- description: "Invalid account id supplied"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- post:
- tags:
- - "Account"
- summary: "Block an account"
- description: ""
- operationId: "addAccountBlockingState"
- consumes:
- - "application/json"
- parameters:
- - name: "accountId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- $ref: "#/definitions/BlockingState"
- - name: "requestedDate"
+ - name: "itemAdjustUnpaidInvoices"
in: "query"
+ type: "boolean"
+ default: false
required: false
- type: "string"
- format: "date"
- - name: "pluginProperty"
+ - name: "removeFutureNotifications"
in: "query"
+ type: "boolean"
+ default: true
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"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
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/{accountId}/auditLogs:
- get:
- tags:
- - "Account"
- summary: "Retrieve audit logs by account id"
- description: ""
- operationId: "getAccountAuditLogs"
produces:
- "application/json"
- parameters:
- - name: "accountId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
- "404":
- description: "Account not found"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
/1.0/kb/accounts:
get:
tags:
- "Account"
summary: "Retrieve an account by external key"
- description: ""
operationId: "getAccountByKey"
- produces:
- - "application/json"
parameters:
- name: "externalKey"
in: "query"
@@ -514,14 +395,14 @@ paths:
type: "string"
- name: "accountWithBalance"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "accountWithBalanceAndCBA"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "audit"
in: "query"
required: false
@@ -542,16 +423,13 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
post:
tags:
- "Account"
summary: "Create account"
- description: ""
operationId: "createAccount"
- consumes:
- - "application/json"
- produces:
- - "application/json"
parameters:
- in: "body"
name: "body"
@@ -564,12 +442,12 @@ paths:
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
description: "Account created successfully"
@@ -581,43 +459,23 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/search/{searchKey}:
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/accounts/{accountId}/customFields:
get:
tags:
- "Account"
- summary: "Search accounts"
- description: ""
- operationId: "searchAccounts"
- produces:
- - "application/json"
+ summary: "Retrieve account custom fields"
+ operationId: "getAccountCustomFields"
parameters:
- - name: "searchKey"
+ - name: "accountId"
in: "path"
required: true
type: "string"
- pattern: ".*"
- - name: "offset"
- in: "query"
- required: false
- type: "integer"
- default: 0
- format: "int64"
- - name: "limit"
- in: "query"
- required: false
- type: "integer"
- default: 100
- format: "int64"
- - name: "accountWithBalance"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "accountWithBalanceAndCBA"
- in: "query"
- required: false
- type: "boolean"
- default: false
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- name: "audit"
in: "query"
required: false
@@ -633,121 +491,139 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/Account"
+ $ref: "#/definitions/CustomField"
+ "400":
+ description: "Invalid account id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/emails:
- get:
- tags:
- - "Account"
- summary: "Retrieve an account emails"
- description: ""
- operationId: "getEmails"
produces:
- "application/json"
+ put:
+ tags:
+ - "Account"
+ summary: "Modify custom fields to account"
+ operationId: "modifyAccountCustomFields"
parameters:
- name: "accountId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - 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"
+ type: "string"
+ required: false
+ - name: "X-Killbill-Comment"
+ in: "header"
+ type: "string"
+ required: false
responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/AccountEmail"
+ "204":
+ description: "Successful operation"
"400":
description: "Invalid account id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
post:
tags:
- "Account"
- summary: "Add account email"
- description: ""
- operationId: "addEmail"
- consumes:
- - "application/json"
- produces:
- - "application/json"
+ summary: "Add custom fields to account"
+ operationId: "createAccountCustomFields"
parameters:
- name: "accountId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
schema:
- $ref: "#/definitions/AccountEmail"
+ 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"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
- description: "Email created successfully"
+ description: "Custom field created successfully"
schema:
type: "array"
items:
- $ref: "#/definitions/AccountEmail"
+ $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}:
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
delete:
tags:
- "Account"
- summary: "Delete email from account"
- description: ""
- operationId: "removeEmail"
- produces:
- - "application/json"
+ summary: "Remove custom fields from account"
+ operationId: "deleteAccountCustomFields"
parameters:
- name: "accountId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "email"
- in: "path"
- required: true
- type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "customField"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ format: "uuid"
+ collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"204":
description: "Successful operation"
@@ -757,84 +633,28 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/pagination:
- get:
- tags:
- - "Account"
- summary: "List accounts"
- description: ""
- operationId: "getAccounts"
produces:
- "application/json"
- parameters:
- - name: "offset"
- in: "query"
- required: false
- type: "integer"
- default: 0
- format: "int64"
- - name: "limit"
- in: "query"
- required: false
- type: "integer"
- default: 100
- format: "int64"
- - name: "accountWithBalance"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "accountWithBalanceAndCBA"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "audit"
- in: "query"
- required: false
- type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
- responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/Account"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}:
+ consumes:
+ - "application/json"
+ /1.0/kb/accounts/{accountId}/tags:
get:
tags:
- "Account"
- summary: "Retrieve an account by id"
- description: ""
- operationId: "getAccount"
- produces:
- - "application/json"
+ summary: "Retrieve account tags"
+ operationId: "getAccountTags"
parameters:
- name: "accountId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "accountWithBalance"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "includedDeleted"
in: "query"
- required: false
type: "boolean"
default: false
- - name: "accountWithBalanceAndCBA"
- in: "query"
required: false
- type: "boolean"
- default: false
- name: "audit"
in: "query"
required: false
@@ -848,7 +668,9 @@ paths:
"200":
description: "successful operation"
schema:
- $ref: "#/definitions/Account"
+ type: "array"
+ items:
+ $ref: "#/definitions/Tag"
"400":
description: "Invalid account id supplied"
"404":
@@ -857,136 +679,133 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- put:
- tags:
- - "Account"
- summary: "Update account"
- description: ""
- operationId: "updateAccount"
- consumes:
- - "application/json"
produces:
- "application/json"
+ post:
+ tags:
+ - "Account"
+ summary: "Add tags to account"
+ operationId: "createAccountTags"
parameters:
- name: "accountId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
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
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
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: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
delete:
tags:
- "Account"
- summary: "Close account"
- description: ""
- operationId: "closeAccount"
- produces:
- - "application/json"
+ summary: "Remove tags from account"
+ operationId: "deleteAccountTags"
parameters:
- name: "accountId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "cancelAllSubscriptions"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "writeOffUnpaidInvoices"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "itemAdjustUnpaidInvoices"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "removeFutureNotifications"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "tagDef"
in: "query"
+ type: "array"
+ items:
+ type: "string"
+ format: "uuid"
+ collectionFormat: "multi"
required: false
- type: "boolean"
- default: true
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"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}/children:
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/accounts/{accountId}/paymentMethods:
get:
tags:
- "Account"
- summary: "List children accounts"
- description: ""
- operationId: "getChildrenAccounts"
- produces:
- - "application/json"
+ summary: "Retrieve account payment methods"
+ operationId: "getPaymentMethodsForAccount"
parameters:
- name: "accountId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "accountWithBalance"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "withPluginInfo"
in: "query"
- required: false
type: "boolean"
default: false
- - name: "accountWithBalanceAndCBA"
- in: "query"
required: false
+ - name: "includedDeleted"
+ in: "query"
type: "boolean"
default: false
+ required: false
+ - name: "pluginProperty"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ required: false
- name: "audit"
in: "query"
required: false
@@ -1002,327 +821,217 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/Account"
+ $ref: "#/definitions/PaymentMethod"
"400":
- description: "Invalid parent account id supplied"
+ description: "Invalid account id supplied"
"404":
- description: "Parent Account not found"
+ description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{childAccountId}/transferCredit:
- put:
- tags:
- - "Account"
- summary: "Move a given child credit to the parent level"
- description: ""
- operationId: "transferChildCreditToParent"
- consumes:
- - "application/json"
produces:
- "application/json"
+ post:
+ tags:
+ - "Account"
+ summary: "Add a payment method"
+ operationId: "createPaymentMethod"
parameters:
- - name: "childAccountId"
+ - name: "accountId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/PaymentMethod"
+ - name: "isDefault"
+ in: "query"
+ type: "boolean"
+ default: false
+ required: false
+ - name: "payAllUnpaidInvoices"
+ in: "query"
+ type: "boolean"
+ default: false
+ required: false
+ - name: "controlPluginName"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ required: false
+ - name: "pluginProperty"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
- "204":
- description: "Successful operation"
+ "201":
+ description: "Payment method created"
+ schema:
+ $ref: "#/definitions/PaymentMethod"
"400":
- description: "Account does not have credit"
+ description: "Invalid account id supplied"
"404":
description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/invoicePayments:
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/accounts/{accountId}/auditLogs:
get:
tags:
- "Account"
- summary: "Retrieve account invoice payments"
- description: ""
- operationId: "getInvoicePayments"
- produces:
- - "application/json"
+ summary: "Retrieve audit logs by account id"
+ operationId: "getAccountAuditLogs"
parameters:
- name: "accountId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "withPluginInfo"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "withAttempts"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "audit"
- in: "query"
- required: false
- type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
responses:
"200":
description: "successful operation"
schema:
type: "array"
items:
- $ref: "#/definitions/InvoicePayment"
- "400":
- description: "Invalid account id supplied"
+ $ref: "#/definitions/AuditLog"
"404":
description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- post:
- tags:
- - "Account"
- summary: "Trigger a payment for all unpaid invoices"
- description: ""
- operationId: "payAllInvoices"
- consumes:
- - "application/json"
produces:
- "application/json"
+ /1.0/kb/accounts/{accountId}/auditLogsWithHistory:
+ get:
+ tags:
+ - "Account"
+ summary: "Retrieve account audit logs with history by account id"
+ operationId: "getAccountAuditLogsWithHistory"
parameters:
- name: "accountId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "paymentMethodId"
- in: "query"
- required: false
- type: "string"
format: "uuid"
- - name: "externalPayment"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "paymentAmount"
- in: "query"
- required: false
- type: "number"
- - name: "targetDate"
- in: "query"
- required: false
- type: "string"
- format: "date"
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
responses:
- "201":
- description: "Successful operation"
+ "200":
+ description: "successful operation"
schema:
type: "array"
items:
- $ref: "#/definitions/Invoice"
- "204":
- description: "Nothing to pay"
+ $ref: "#/definitions/AuditLog"
"404":
- description: "Invalid account id supplied"
+ 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"
+ /1.0/kb/accounts/{accountId}/bundles:
+ get:
+ tags:
+ - "Account"
+ summary: "Retrieve bundles for account"
+ operationId: "getAccountBundles"
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"
+ - name: "externalKey"
in: "query"
+ type: "string"
required: false
- type: "boolean"
- default: false
- - name: "pluginProperty"
+ - name: "bundlesFilter"
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"
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/Bundle"
"400":
- description: "Invalid account id or payment method id supplied"
+ description: "Invalid account id supplied"
"404":
description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/paymentMethods/refresh:
- put:
- tags:
- - "Account"
- summary: "Refresh account payment methods"
- description: ""
- operationId: "refreshPaymentMethods"
produces:
- "application/json"
+ /1.0/kb/accounts/{accountId}/bundles/pagination:
+ get:
+ tags:
+ - "Account"
+ summary: "Retrieve paginated bundles for account"
+ operationId: "getAccountBundlesPaginated"
parameters:
- name: "accountId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "pluginName"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "offset"
in: "query"
+ type: "integer"
+ format: "int64"
+ default: 0
required: false
- type: "string"
- - name: "pluginProperty"
+ - name: "limit"
in: "query"
+ type: "integer"
+ format: "int64"
+ default: 100
required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
- responses:
- "204":
- description: "Successful operation"
- "400":
- description: "Invalid account id supplied"
- "404":
- description: "Account not found"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/paymentMethods:
- get:
- tags:
- - "Account"
- summary: "Retrieve account payment methods"
- description: ""
- operationId: "getPaymentMethodsForAccount"
- produces:
- - "application/json"
- parameters:
- - name: "accountId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "withPluginInfo"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "includedDeleted"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "audit"
- in: "query"
+ - name: "audit"
+ in: "query"
required: false
type: "string"
default: "NONE"
@@ -1336,7 +1045,7 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/PaymentMethod"
+ $ref: "#/definitions/Bundle"
"400":
description: "Invalid account id supplied"
"404":
@@ -1345,93 +1054,27 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- post:
- tags:
- - "Account"
- summary: "Add a payment method"
- description: ""
- operationId: "createPaymentMethod"
- 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/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"
- 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}/auditLogsWithHistory:
+ /1.0/kb/accounts/{accountId}/emails/{accountEmailId}/auditLogsWithHistory:
get:
tags:
- "Account"
- summary: "Retrieve account audit logs with history by account id"
- description: ""
- operationId: "getAccountAuditLogsWithHistory"
- produces:
- - "application/json"
+ summary: "Retrieve account email audit logs with history by id"
+ operationId: "getAccountEmailAuditLogsWithHistory"
parameters:
- name: "accountId"
in: "path"
required: true
type: "string"
+ format: "uuid"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "accountEmailId"
+ in: "path"
+ required: true
+ type: "string"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
responses:
"200":
description: "successful operation"
@@ -1445,30 +1088,26 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/bundles:
+ produces:
+ - "application/json"
+ /1.0/kb/accounts/{accountId}/timeline:
get:
tags:
- "Account"
- summary: "Retrieve bundles for account"
- description: ""
- operationId: "getAccountBundles"
- produces:
- - "application/json"
+ summary: "Retrieve account timeline"
+ operationId: "getAccountTimeline"
parameters:
- name: "accountId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "externalKey"
- in: "query"
- required: false
- type: "string"
- - name: "bundlesFilter"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "parallel"
in: "query"
+ type: "boolean"
+ default: false
required: false
- type: "string"
- name: "audit"
in: "query"
required: false
@@ -1482,9 +1121,7 @@ paths:
"200":
description: "successful operation"
schema:
- type: "array"
- items:
- $ref: "#/definitions/Bundle"
+ $ref: "#/definitions/AccountTimeline"
"400":
description: "Invalid account id supplied"
"404":
@@ -1493,34 +1130,37 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/bundles/pagination:
+ produces:
+ - "application/json"
+ /1.0/kb/accounts/pagination:
get:
tags:
- "Account"
- summary: "Retrieve paginated bundles for account"
- description: ""
- operationId: "getAccountBundlesPaginated"
- produces:
- - "application/json"
+ summary: "List accounts"
+ operationId: "getAccounts"
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"
+ default: 0
+ required: false
- name: "limit"
in: "query"
- required: false
type: "integer"
- default: 100
format: "int64"
+ default: 100
+ required: false
+ - name: "accountWithBalance"
+ in: "query"
+ type: "boolean"
+ default: false
+ required: false
+ - name: "accountWithBalanceAndCBA"
+ in: "query"
+ type: "boolean"
+ default: false
+ required: false
- name: "audit"
in: "query"
required: false
@@ -1536,71 +1176,118 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/Bundle"
- "400":
- description: "Invalid account id supplied"
- "404":
- description: "Account not found"
+ $ref: "#/definitions/Account"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/emails/{accountEmailId}/auditLogsWithHistory:
+ produces:
+ - "application/json"
+ /1.0/kb/accounts/{accountId}/allCustomFields:
get:
tags:
- "Account"
- summary: "Retrieve account email audit logs with history by id"
- description: ""
- operationId: "getAccountEmailAuditLogsWithHistory"
- produces:
- - "application/json"
+ summary: "Retrieve account customFields"
+ operationId: "getAllCustomFields"
parameters:
- name: "accountId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "accountEmailId"
- in: "path"
- required: true
- type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
+ - name: "objectType"
+ in: "query"
+ 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"
+ required: 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/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}/timeline:
- get:
- tags:
- - "Account"
- summary: "Retrieve account timeline"
- description: ""
- operationId: "getAccountTimeline"
produces:
- "application/json"
+ /1.0/kb/accounts/{accountId}/allTags:
+ get:
+ tags:
+ - "Account"
+ summary: "Retrieve account tags"
+ operationId: "getAllTags"
parameters:
- name: "accountId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "parallel"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "objectType"
in: "query"
+ 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"
required: false
+ - name: "includedDeleted"
+ in: "query"
type: "boolean"
default: false
+ required: false
- name: "audit"
in: "query"
required: false
@@ -1614,7 +1301,9 @@ paths:
"200":
description: "successful operation"
schema:
- $ref: "#/definitions/AccountTimeline"
+ type: "array"
+ items:
+ $ref: "#/definitions/Tag"
"400":
description: "Invalid account id supplied"
"404":
@@ -1623,46 +1312,59 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/allCustomFields:
+ produces:
+ - "application/json"
+ /1.0/kb/accounts/block/{blockingId}/auditLogsWithHistory:
get:
tags:
- "Account"
- summary: "Retrieve account customFields"
- description: ""
- operationId: "getAllCustomFields"
+ summary: "Retrieve blocking state audit logs with history by id"
+ operationId: "getBlockingStateAuditLogsWithHistory"
+ parameters:
+ - name: "blockingId"
+ in: "path"
+ required: true
+ type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ 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: []
produces:
- "application/json"
+ /1.0/kb/accounts/{accountId}/children:
+ get:
+ tags:
+ - "Account"
+ summary: "List children accounts"
+ operationId: "getChildrenAccounts"
parameters:
- name: "accountId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "objectType"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "accountWithBalance"
in: "query"
+ type: "boolean"
+ default: false
+ required: false
+ - name: "accountWithBalanceAndCBA"
+ in: "query"
+ type: "boolean"
+ default: false
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
@@ -1678,60 +1380,47 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/CustomField"
+ $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}/allTags:
+ produces:
+ - "application/json"
+ /1.0/kb/accounts/{accountId}/invoicePayments:
get:
tags:
- "Account"
- summary: "Retrieve account tags"
- description: ""
- operationId: "getAllTags"
- produces:
- - "application/json"
+ summary: "Retrieve account invoice payments"
+ operationId: "getInvoicePayments"
parameters:
- name: "accountId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "objectType"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "withPluginInfo"
in: "query"
+ type: "boolean"
+ default: false
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"
+ - name: "withAttempts"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
+ - name: "pluginProperty"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ required: false
- name: "audit"
in: "query"
required: false
@@ -1747,7 +1436,7 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/Tag"
+ $ref: "#/definitions/InvoicePayment"
"400":
description: "Invalid account id supplied"
"404":
@@ -1756,85 +1445,124 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/block/{blockingId}/auditLogsWithHistory:
- get:
- tags:
- - "Account"
- summary: "Retrieve blocking state audit logs with history by id"
- description: ""
- operationId: "getBlockingStateAuditLogsWithHistory"
produces:
- "application/json"
+ post:
+ tags:
+ - "Account"
+ summary: "Trigger a payment for all unpaid invoices"
+ operationId: "payAllInvoices"
parameters:
- - name: "blockingId"
+ - name: "accountId"
in: "path"
required: true
type: "string"
+ format: "uuid"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "paymentMethodId"
+ in: "query"
+ type: "string"
format: "uuid"
+ required: false
+ - name: "externalPayment"
+ in: "query"
+ type: "boolean"
+ default: false
+ required: false
+ - name: "paymentAmount"
+ in: "query"
+ type: "number"
+ required: false
+ - name: "targetDate"
+ in: "query"
+ type: "string"
+ format: "date"
+ required: false
+ - name: "pluginProperty"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ required: false
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ type: "string"
+ required: false
+ - name: "X-Killbill-Comment"
+ in: "header"
+ type: "string"
+ required: false
responses:
- "200":
- description: "successful operation"
+ "201":
+ description: "Successful operation"
schema:
type: "array"
items:
- $ref: "#/definitions/AuditLog"
+ $ref: "#/definitions/Invoice"
+ "204":
+ description: "Nothing to pay"
"404":
- description: "Blocking state not found"
+ description: "Invalid account id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
/1.0/kb/accounts/{accountId}/invoices:
get:
tags:
- "Account"
summary: "Retrieve account invoices"
- description: ""
operationId: "getInvoicesForAccount"
- produces:
- - "application/json"
parameters:
- name: "accountId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- name: "startDate"
in: "query"
- required: false
type: "string"
format: "date"
+ required: false
- name: "endDate"
in: "query"
- required: false
type: "string"
format: "date"
+ required: false
- name: "withMigrationInvoices"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "unpaidInvoicesOnly"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "includeVoidedInvoices"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "includeInvoiceComponents"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "invoicesFilter"
in: "query"
- required: false
type: "string"
+ required: false
- name: "audit"
in: "query"
required: false
@@ -1859,34 +1587,33 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
/1.0/kb/accounts/{accountId}/invoices/pagination:
get:
tags:
- "Account"
summary: "Retrieve paginated invoices for account"
- description: ""
operationId: "getInvoicesForAccountPaginated"
- produces:
- - "application/json"
parameters:
- name: "accountId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- name: "offset"
in: "query"
- required: false
type: "integer"
- default: 0
format: "int64"
+ default: 0
+ required: false
- name: "limit"
in: "query"
- required: false
type: "integer"
- default: 100
format: "int64"
+ default: 100
+ required: false
- name: "audit"
in: "query"
required: false
@@ -1911,22 +1638,21 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
/1.0/kb/accounts/{accountId}/overdue:
get:
tags:
- "Account"
summary: "Retrieve overdue state for account"
- description: ""
operationId: "getOverdueAccount"
- produces:
- - "application/json"
parameters:
- name: "accountId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
responses:
"200":
description: "successful operation"
@@ -1940,39 +1666,38 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
/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"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- name: "withAttempts"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "withPluginInfo"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "audit"
in: "query"
required: false
@@ -1995,23 +1720,20 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
post:
tags:
- "Account"
summary: "Trigger a payment (authorization, purchase or credit)"
- description: ""
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"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
@@ -2019,35 +1741,35 @@ paths:
$ref: "#/definitions/PaymentTransaction"
- name: "paymentMethodId"
in: "query"
- required: false
type: "string"
format: "uuid"
+ required: false
- name: "controlPluginName"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
description: "Payment transaction created successfully"
@@ -2071,18 +1793,17 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
/1.0/kb/accounts/payments:
post:
tags:
- "Account"
summary: "Trigger a payment using the account external key (authorization, purchase\
\ or credit)"
- description: ""
operationId: "processPaymentByExternalKey"
- consumes:
- - "application/json"
- produces:
- - "application/json"
parameters:
- in: "body"
name: "body"
@@ -2095,35 +1816,35 @@ paths:
type: "string"
- name: "paymentMethodId"
in: "query"
- required: false
type: "string"
format: "uuid"
+ required: false
- name: "controlPluginName"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
description: "Payment transaction created successfully"
@@ -2147,36 +1868,35 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
/1.0/kb/accounts/{accountId}/cbaRebalancing:
put:
tags:
- "Account"
summary: "Rebalance account CBA"
- description: ""
operationId: "rebalanceExistingCBAOnAccount"
- consumes:
- - "application/json"
- produces:
- - "application/json"
parameters:
- name: "accountId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"204":
description: "Successful operation"
@@ -2186,166 +1906,326 @@ paths:
- 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:
+ consumes:
- "application/json"
- parameters: []
+ /1.0/kb/accounts/{accountId}/paymentMethods/refresh:
+ put:
+ tags:
+ - "Account"
+ summary: "Refresh account payment methods"
+ operationId: "refreshPaymentMethods"
+ parameters:
+ - name: "accountId"
+ in: "path"
+ required: true
+ type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "pluginName"
+ in: "query"
+ type: "string"
+ required: false
+ - name: "pluginProperty"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ required: false
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ type: "string"
+ required: false
+ - name: "X-Killbill-Comment"
+ in: "header"
+ type: "string"
+ required: false
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/admin/payments/{paymentId}/transactions/{paymentTransactionId}:
- put:
- tags:
- - "Admin"
- summary: "Update existing paymentTransaction and associated payment state"
- description: ""
- operationId: "updatePaymentTransactionState"
- consumes:
- - "application/json"
produces:
- "application/json"
+ /1.0/kb/accounts/{accountId}/emails/{email}:
+ delete:
+ tags:
+ - "Account"
+ summary: "Delete email from account"
+ operationId: "removeEmail"
parameters:
- - name: "paymentId"
+ - name: "accountId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "paymentTransactionId"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "email"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- $ref: "#/definitions/AdminPayment"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"204":
description: "Successful operation"
"400":
- description: "Invalid account data supplied"
+ description: "Invalid account id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/admin/queues:
+ produces:
+ - "application/json"
+ /1.0/kb/accounts/search/{searchKey}:
get:
tags:
- - "Admin"
- summary: "Get queues entries"
- description: ""
- operationId: "getQueueEntries"
- produces:
- - "application/octet-stream"
+ - "Account"
+ summary: "Search accounts"
+ operationId: "searchAccounts"
parameters:
- - name: "accountId"
- in: "query"
- required: false
+ - name: "searchKey"
+ in: "path"
+ required: true
type: "string"
- format: "uuid"
- - name: "queueName"
+ pattern: ".*"
+ - name: "offset"
in: "query"
+ type: "integer"
+ format: "int64"
+ default: 0
required: false
- type: "string"
- - name: "serviceName"
+ - name: "limit"
in: "query"
+ type: "integer"
+ format: "int64"
+ default: 100
required: false
- type: "string"
- - name: "withHistory"
+ - name: "accountWithBalance"
in: "query"
- required: false
type: "boolean"
- default: true
- - name: "minDate"
- in: "query"
- required: false
- type: "string"
- - name: "maxDate"
- in: "query"
+ default: false
required: false
- type: "string"
- - name: "withInProcessing"
+ - name: "accountWithBalanceAndCBA"
in: "query"
- required: false
type: "boolean"
- default: true
- - name: "withBusEvents"
- in: "query"
+ default: false
required: false
- type: "boolean"
- default: true
- - name: "withNotifications"
+ - name: "audit"
in: "query"
required: false
- type: "boolean"
- default: true
+ type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
responses:
"200":
- description: "Success"
- "400":
- description: "Invalid account id supplied"
- "404":
- description: "Account not found"
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/Account"
security:
- 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"
+ /1.0/kb/accounts/{accountId}/paymentMethods/{paymentMethodId}/setDefault:
+ put:
+ tags:
+ - "Account"
+ summary: "Set the default payment method"
+ operationId: "setDefaultPaymentMethod"
parameters:
- - name: "cacheName"
- in: "query"
- required: false
+ - name: "accountId"
+ in: "path"
+ required: true
type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "paymentMethodId"
+ in: "path"
+ required: true
+ type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "payAllUnpaidInvoices"
+ in: "query"
+ type: "boolean"
+ default: false
+ required: false
+ - name: "pluginProperty"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ required: false
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ type: "string"
+ required: false
+ - name: "X-Killbill-Comment"
+ in: "header"
+ type: "string"
+ required: false
+ 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: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/accounts/{childAccountId}/transferCredit:
+ put:
+ tags:
+ - "Account"
+ summary: "Move a given child credit to the parent level"
+ operationId: "transferChildCreditToParent"
+ parameters:
+ - name: "childAccountId"
+ in: "path"
+ required: true
+ type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ type: "string"
+ required: false
+ - name: "X-Killbill-Comment"
+ in: "header"
+ type: "string"
+ required: false
+ 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: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/admin/queues:
+ get:
+ tags:
+ - "Admin"
+ summary: "Get queues entries"
+ operationId: "getQueueEntries"
+ parameters:
+ - name: "accountId"
+ in: "query"
+ type: "string"
+ format: "uuid"
+ required: false
+ - name: "queueName"
+ in: "query"
+ type: "string"
+ required: false
+ - name: "serviceName"
+ in: "query"
+ type: "string"
+ required: false
+ - name: "withHistory"
+ in: "query"
+ type: "boolean"
+ default: true
+ required: false
+ - name: "minDate"
+ in: "query"
+ type: "string"
+ required: false
+ - name: "maxDate"
+ in: "query"
+ type: "string"
+ required: false
+ - name: "withInProcessing"
+ in: "query"
+ type: "boolean"
+ default: true
+ required: false
+ - name: "withBusEvents"
+ in: "query"
+ type: "boolean"
+ default: true
+ required: false
+ - name: "withNotifications"
+ in: "query"
+ type: "boolean"
+ default: true
+ required: false
+ responses:
+ "200":
+ description: "successful operation"
+ "400":
+ description: "Invalid account id supplied"
+ "404":
+ description: "Account not found"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ produces:
+ - "application/octet-stream"
+ /1.0/kb/admin/cache:
+ delete:
+ tags:
+ - "Admin"
+ summary: "Invalidates the given Cache if specified, otherwise invalidates all\
+ \ caches"
+ operationId: "invalidatesCache"
+ parameters:
+ - name: "cacheName"
+ in: "query"
+ type: "string"
+ required: false
responses:
"204":
description: "Successful operation"
@@ -2355,22 +2235,21 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
/1.0/kb/admin/cache/accounts/{accountId}:
delete:
tags:
- "Admin"
summary: "Invalidates Caches per account level"
- description: ""
operationId: "invalidatesCacheByAccount"
- produces:
- - "application/json"
parameters:
- name: "accountId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
responses:
"204":
description: "Successful operation"
@@ -2380,16 +2259,43 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
/1.0/kb/admin/cache/tenants:
delete:
tags:
- "Admin"
summary: "Invalidates Caches per tenant level"
- description: ""
operationId: "invalidatesCacheByTenant"
+ responses:
+ "204":
+ description: "Successful operation"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ produces:
+ - "application/json"
+ /1.0/kb/admin/healthcheck:
+ put:
+ tags:
+ - "Admin"
+ summary: "Put the host back into rotation"
+ operationId: "putInRotation"
+ responses:
+ "204":
+ description: "Successful operation"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
produces:
- "application/json"
- parameters: []
+ delete:
+ tags:
+ - "Admin"
+ summary: "Put the host out of rotation"
+ operationId: "putOutOfRotation"
responses:
"204":
description: "Successful operation"
@@ -2397,49 +2303,46 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
/1.0/kb/admin/invoices:
post:
tags:
- "Admin"
summary: "Trigger an invoice generation for all parked accounts"
- description: ""
operationId: "triggerInvoiceGenerationForParkedAccounts"
- consumes:
- - "application/json"
- produces:
- - "application/json"
parameters:
- name: "offset"
in: "query"
- required: false
type: "integer"
- default: 0
format: "int64"
+ default: 0
+ required: false
- name: "limit"
in: "query"
- required: false
type: "integer"
- default: 100
format: "int64"
+ default: 100
+ required: false
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"200":
description: "Successful operation"
@@ -2447,143 +2350,131 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/bundles/{bundleId}:
- get:
- tags:
- - "Bundle"
- summary: "Retrieve a bundle by id"
- description: ""
- operationId: "getBundle"
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/admin/payments/{paymentId}/transactions/{paymentTransactionId}:
+ put:
+ tags:
+ - "Admin"
+ summary: "Update existing paymentTransaction and associated payment state"
+ operationId: "updatePaymentTransactionState"
parameters:
- - name: "bundleId"
+ - name: "paymentId"
in: "path"
required: true
type: "string"
+ format: "uuid"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "paymentTransactionId"
+ in: "path"
+ required: true
+ type: "string"
format: "uuid"
- - name: "audit"
- in: "query"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/AdminPayment"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ type: "string"
required: false
+ - name: "X-Killbill-Comment"
+ in: "header"
type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
+ required: false
responses:
- "200":
- description: "successful operation"
- schema:
- $ref: "#/definitions/Bundle"
+ "204":
+ description: "Successful operation"
"400":
- description: "Invalid bundle id supplied"
- "404":
- description: "Bundle not found"
+ description: "Invalid account data supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/bundles/{bundleId}/block:
post:
tags:
- "Bundle"
- summary: "Transfer a bundle to another account"
- description: ""
- operationId: "transferBundle"
- consumes:
- - "application/json"
- produces:
- - "application/json"
+ summary: "Block a bundle"
+ operationId: "addBundleBlockingState"
parameters:
- name: "bundleId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
schema:
- $ref: "#/definitions/Bundle"
+ $ref: "#/definitions/BlockingState"
- 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"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
- description: "Bundle transferred successfully"
+ description: "Blocking state created successfully"
schema:
- $ref: "#/definitions/Bundle"
+ type: "array"
+ items:
+ $ref: "#/definitions/BlockingState"
"400":
- description: "Invalid bundle id, requested date or policy supplied"
+ description: "Invalid bundle id supplied"
"404":
description: "Bundle not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/bundles/{bundleId}/tags:
+ consumes:
+ - "application/json"
+ /1.0/kb/bundles/{bundleId}/customFields:
get:
tags:
- "Bundle"
- summary: "Retrieve bundle tags"
- description: ""
- operationId: "getBundleTags"
- produces:
- - "application/json"
+ summary: "Retrieve bundle custom fields"
+ operationId: "getBundleCustomFields"
parameters:
- name: "bundleId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "includedDeleted"
- in: "query"
- required: false
- type: "boolean"
- default: false
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- name: "audit"
in: "query"
required: false
@@ -2599,102 +2490,139 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/Tag"
+ $ref: "#/definitions/CustomField"
"400":
description: "Invalid bundle id supplied"
- "404":
- description: "Bundle not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- post:
+ produces:
+ - "application/json"
+ put:
tags:
- "Bundle"
- summary: "Add tags to bundle"
- description: ""
- operationId: "createBundleTags"
- consumes:
- - "application/json"
+ summary: "Modify custom fields to bundle"
+ operationId: "modifyBundleCustomFields"
+ parameters:
+ - name: "bundleId"
+ in: "path"
+ required: true
+ type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - 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"
+ type: "string"
+ required: false
+ - name: "X-Killbill-Comment"
+ in: "header"
+ type: "string"
+ required: false
+ responses:
+ "204":
+ description: "Successful operation"
+ "400":
+ description: "Invalid bundle id supplied"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ post:
+ tags:
+ - "Bundle"
+ summary: "Add custom fields to bundle"
+ operationId: "createBundleCustomFields"
parameters:
- name: "bundleId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
schema:
type: "array"
items:
- type: "string"
- format: "uuid"
+ $ref: "#/definitions/CustomField"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
- description: "Tag created successfully"
+ description: "Custom field created successfully"
schema:
type: "array"
items:
- $ref: "#/definitions/Tag"
+ $ref: "#/definitions/CustomField"
"400":
description: "Invalid bundle id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
delete:
tags:
- "Bundle"
- summary: "Remove tags from bundle"
- description: ""
- operationId: "deleteBundleTags"
- consumes:
- - "application/json"
- produces:
- - "application/json"
+ summary: "Remove custom fields from bundle"
+ operationId: "deleteBundleCustomFields"
parameters:
- name: "bundleId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "tagDef"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "customField"
in: "query"
- required: false
type: "array"
items:
type: "string"
format: "uuid"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"204":
description: "Successful operation"
@@ -2704,22 +2632,28 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/bundles/{bundleId}/customFields:
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/bundles/{bundleId}/tags:
get:
tags:
- "Bundle"
- summary: "Retrieve bundle custom fields"
- description: ""
- operationId: "getBundleCustomFields"
- produces:
- - "application/json"
+ summary: "Retrieve bundle tags"
+ operationId: "getBundleTags"
parameters:
- name: "bundleId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "includedDeleted"
+ in: "query"
+ type: "boolean"
+ default: false
+ required: false
- name: "audit"
in: "query"
required: false
@@ -2735,98 +2669,98 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/CustomField"
+ $ref: "#/definitions/Tag"
"400":
description: "Invalid bundle id supplied"
+ "404":
+ description: "Bundle not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
post:
tags:
- "Bundle"
- summary: "Add custom fields to bundle"
- description: ""
- operationId: "createBundleCustomFields"
- consumes:
- - "application/json"
- produces:
- - "application/json"
+ summary: "Add tags to bundle"
+ operationId: "createBundleTags"
parameters:
- name: "bundleId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
schema:
type: "array"
items:
- $ref: "#/definitions/CustomField"
+ type: "string"
+ format: "uuid"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
- description: "Custom field created successfully"
+ description: "Tag created successfully"
schema:
type: "array"
items:
- $ref: "#/definitions/CustomField"
+ $ref: "#/definitions/Tag"
"400":
description: "Invalid bundle id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- put:
- tags:
- - "Bundle"
- summary: "Modify custom fields to bundle"
- description: ""
- operationId: "modifyBundleCustomFields"
- consumes:
- - "application/json"
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ delete:
+ tags:
+ - "Bundle"
+ summary: "Remove tags from bundle"
+ operationId: "deleteBundleTags"
parameters:
- name: "bundleId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- type: "array"
- items:
- $ref: "#/definitions/CustomField"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "tagDef"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ format: "uuid"
+ collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"204":
description: "Successful operation"
@@ -2836,61 +2770,158 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- delete:
- tags:
- - "Bundle"
- summary: "Remove custom fields from bundle"
- description: ""
- operationId: "deleteBundleCustomFields"
+ produces:
+ - "application/json"
consumes:
- "application/json"
+ /1.0/kb/bundles/{bundleId}:
+ get:
+ tags:
+ - "Bundle"
+ summary: "Retrieve a bundle by id"
+ operationId: "getBundle"
+ parameters:
+ - name: "bundleId"
+ in: "path"
+ required: true
+ type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "audit"
+ in: "query"
+ required: false
+ type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ $ref: "#/definitions/Bundle"
+ "400":
+ description: "Invalid bundle id supplied"
+ "404":
+ description: "Bundle not found"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
produces:
- "application/json"
+ post:
+ tags:
+ - "Bundle"
+ summary: "Transfer a bundle to another account"
+ operationId: "transferBundle"
parameters:
- name: "bundleId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "customField"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/Bundle"
+ - name: "requestedDate"
+ in: "query"
+ type: "string"
+ format: "date"
+ required: false
+ - name: "billingPolicy"
+ in: "query"
+ type: "string"
+ default: "END_OF_TERM"
+ enum:
+ - "START_OF_TERM"
+ - "END_OF_TERM"
+ - "IMMEDIATE"
+ - "ILLEGAL"
+ required: false
+ - name: "bcdTransfer"
in: "query"
+ type: "string"
+ default: "USE_EXISTING"
+ enum:
+ - "NONE"
+ - "USE_EXISTING"
+ - "ALIGN_WITH_EFF_DT"
required: false
+ - name: "pluginProperty"
+ in: "query"
type: "array"
items:
type: "string"
- format: "uuid"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
- "204":
- description: "Successful operation"
+ "201":
+ description: "Bundle transferred successfully"
+ schema:
+ $ref: "#/definitions/Bundle"
"400":
- description: "Invalid bundle id supplied"
+ description: "Invalid bundle id, requested date or policy supplied"
+ "404":
+ description: "Bundle not found"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/bundles/{bundleId}/auditLogsWithHistory:
+ get:
+ tags:
+ - "Bundle"
+ summary: "Retrieve bundle audit logs with history by id"
+ operationId: "getBundleAuditLogsWithHistory"
+ parameters:
+ - name: "bundleId"
+ in: "path"
+ required: true
+ type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/AuditLog"
+ "404":
+ description: "Subscription bundle not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
/1.0/kb/bundles:
get:
tags:
- "Bundle"
summary: "Retrieve a bundle by external key"
- description: ""
operationId: "getBundleByKey"
- produces:
- - "application/json"
parameters:
- name: "externalKey"
in: "query"
@@ -2898,9 +2929,9 @@ paths:
type: "string"
- name: "includedDeleted"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "audit"
in: "query"
required: false
@@ -2923,28 +2954,27 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
/1.0/kb/bundles/pagination:
get:
tags:
- "Bundle"
summary: "List bundles"
- description: ""
operationId: "getBundles"
- produces:
- - "application/json"
parameters:
- name: "offset"
in: "query"
- required: false
type: "integer"
- default: 0
format: "int64"
+ default: 0
+ required: false
- name: "limit"
in: "query"
- required: false
type: "integer"
- default: 100
format: "int64"
+ default: 100
+ required: false
- name: "audit"
in: "query"
required: false
@@ -2965,48 +2995,45 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
/1.0/kb/bundles/{bundleId}/pause:
put:
tags:
- "Bundle"
summary: "Pause a bundle"
- description: ""
operationId: "pauseBundle"
- consumes:
- - "application/json"
- produces:
- - "application/json"
parameters:
- name: "bundleId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- name: "requestedDate"
in: "query"
- required: false
type: "string"
format: "date"
+ required: false
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"204":
description: "Successful operation"
@@ -3018,22 +3045,23 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
/1.0/kb/bundles/{bundleId}/renameKey:
put:
tags:
- "Bundle"
summary: "Update a bundle externalKey"
- description: ""
operationId: "renameExternalKey"
- consumes:
- - "application/json"
parameters:
- name: "bundleId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
@@ -3045,12 +3073,12 @@ paths:
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"204":
description: "Successful operation"
@@ -3062,48 +3090,45 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ consumes:
+ - "application/json"
/1.0/kb/bundles/{bundleId}/resume:
put:
tags:
- "Bundle"
summary: "Resume a bundle"
- description: ""
operationId: "resumeBundle"
- consumes:
- - "application/json"
- produces:
- - "application/json"
parameters:
- name: "bundleId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- name: "requestedDate"
in: "query"
- required: false
type: "string"
format: "date"
+ required: false
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"204":
description: "Successful operation"
@@ -3115,15 +3140,16 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
/1.0/kb/bundles/search/{searchKey}:
get:
tags:
- "Bundle"
summary: "Search bundles"
- description: ""
operationId: "searchBundles"
- produces:
- - "application/json"
parameters:
- name: "searchKey"
in: "path"
@@ -3132,16 +3158,16 @@ paths:
pattern: ".*"
- name: "offset"
in: "query"
- required: false
type: "integer"
- default: 0
format: "int64"
+ default: 0
+ required: false
- name: "limit"
in: "query"
- required: false
type: "integer"
- default: 100
format: "int64"
+ default: 100
+ required: false
- name: "audit"
in: "query"
required: false
@@ -3162,153 +3188,62 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/bundles/{bundleId}/block:
+ produces:
+ - "application/json"
+ /1.0/kb/catalog/simplePlan:
post:
tags:
- - "Bundle"
- summary: "Block a bundle"
- description: ""
- operationId: "addBundleBlockingState"
- consumes:
- - "application/json"
+ - "Catalog"
+ summary: "Add a simple plan entry in the current version of the catalog"
+ operationId: "addSimplePlan"
parameters:
- - name: "bundleId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- in: "body"
name: "body"
required: true
schema:
- $ref: "#/definitions/BlockingState"
- - name: "requestedDate"
- in: "query"
- required: false
- type: "string"
- format: "date"
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
+ $ref: "#/definitions/SimplePlan"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
- description: "Blocking state created successfully"
+ description: "Created new plan successfully"
schema:
- type: "array"
- items:
- $ref: "#/definitions/BlockingState"
- "400":
- description: "Invalid bundle id supplied"
- "404":
- description: "Bundle not found"
+ type: "string"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/bundles/{bundleId}/auditLogsWithHistory:
- get:
- tags:
- - "Bundle"
- summary: "Retrieve bundle audit logs with history by id"
- description: ""
- operationId: "getBundleAuditLogsWithHistory"
produces:
- "application/json"
- parameters:
- - name: "bundleId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
- "404":
- description: "Subscription bundle not found"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/catalog/simplePlan:
- post:
- tags:
- - "Catalog"
- summary: "Add a simple plan entry in the current version of the catalog"
- description: ""
- operationId: "addSimplePlan"
consumes:
- "application/json"
- produces:
- - "application/json"
- parameters:
- - in: "body"
- name: "body"
- required: true
- schema:
- $ref: "#/definitions/SimplePlan"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
- responses:
- "201":
- description: "Created new plan successfully"
- schema:
- type: "string"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
/1.0/kb/catalog:
get:
tags:
- "Catalog"
summary: "Retrieve the catalog as JSON"
- description: ""
operationId: "getCatalogJson"
- produces:
- - "application/json"
parameters:
- name: "requestedDate"
in: "query"
- required: false
type: "string"
format: "date-time"
+ required: false
- name: "accountId"
in: "query"
- required: false
type: "string"
format: "uuid"
+ required: false
responses:
"200":
description: "successful operation"
@@ -3320,11 +3255,12 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
delete:
tags:
- "Catalog"
summary: "Delete all versions for a per tenant catalog"
- description: ""
operationId: "deleteCatalog"
parameters:
- name: "X-Killbill-CreatedBy"
@@ -3333,12 +3269,12 @@ paths:
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"204":
description: "Successful operation"
@@ -3351,24 +3287,21 @@ paths:
tags:
- "Catalog"
summary: "Retrieve available add-ons for a given product"
- description: ""
operationId: "getAvailableAddons"
- produces:
- - "application/json"
parameters:
- name: "baseProductName"
in: "query"
- required: false
type: "string"
+ required: false
- name: "priceListName"
in: "query"
- required: false
type: "string"
+ required: false
- name: "accountId"
in: "query"
- required: false
type: "string"
format: "uuid"
+ required: false
responses:
"200":
description: "successful operation"
@@ -3380,21 +3313,20 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
/1.0/kb/catalog/availableBasePlans:
get:
tags:
- "Catalog"
summary: "Retrieve available base plans"
- description: ""
operationId: "getAvailableBasePlans"
- produces:
- - "application/json"
parameters:
- name: "accountId"
in: "query"
- required: false
type: "string"
format: "uuid"
+ required: false
responses:
"200":
description: "successful operation"
@@ -3406,21 +3338,20 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
/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"
+ required: false
responses:
"200":
description: "successful operation"
@@ -3433,26 +3364,25 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
/1.0/kb/catalog/xml:
get:
tags:
- "Catalog"
summary: "Retrieve the full catalog as XML"
- description: ""
operationId: "getCatalogXml"
- produces:
- - "text/xml"
parameters:
- name: "requestedDate"
in: "query"
- required: false
type: "string"
format: "date-time"
+ required: false
- name: "accountId"
in: "query"
- required: false
type: "string"
format: "uuid"
+ required: false
responses:
"200":
description: "successful operation"
@@ -3462,14 +3392,13 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "text/xml"
post:
tags:
- "Catalog"
summary: "Upload the full catalog as XML"
- description: ""
operationId: "uploadCatalogXml"
- consumes:
- - "text/xml"
parameters:
- in: "body"
name: "body"
@@ -3482,12 +3411,12 @@ paths:
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
description: "Catalog XML created successfully"
@@ -3497,26 +3426,25 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ consumes:
+ - "text/xml"
/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: "string"
format: "uuid"
+ required: false
- name: "requestedDate"
in: "query"
- required: false
type: "string"
format: "date"
+ required: false
responses:
"200":
description: "successful operation"
@@ -3526,26 +3454,25 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
/1.0/kb/catalog/plan:
get:
tags:
- "Catalog"
summary: "Retrieve plan for a given subscription and date"
- description: ""
operationId: "getPlanForSubscriptionAndDate"
- produces:
- - "application/json"
parameters:
- name: "subscriptionId"
in: "query"
- required: false
type: "string"
format: "uuid"
+ required: false
- name: "requestedDate"
in: "query"
- required: false
type: "string"
format: "date"
+ required: false
responses:
"200":
description: "successful operation"
@@ -3555,26 +3482,25 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
/1.0/kb/catalog/priceList:
get:
tags:
- "Catalog"
summary: "Retrieve priceList for a given subscription and date"
- description: ""
operationId: "getPriceListForSubscriptionAndDate"
- produces:
- - "application/json"
parameters:
- name: "subscriptionId"
in: "query"
- required: false
type: "string"
format: "uuid"
+ required: false
- name: "requestedDate"
in: "query"
- required: false
type: "string"
format: "date"
+ required: false
responses:
"200":
description: "successful operation"
@@ -3584,26 +3510,25 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
/1.0/kb/catalog/product:
get:
tags:
- "Catalog"
summary: "Retrieve product for a given subscription and date"
- description: ""
operationId: "getProductForSubscriptionAndDate"
- produces:
- - "application/json"
parameters:
- name: "subscriptionId"
in: "query"
- required: false
type: "string"
format: "uuid"
+ required: false
- name: "requestedDate"
in: "query"
- required: false
type: "string"
format: "date"
+ required: false
responses:
"200":
description: "successful operation"
@@ -3613,17 +3538,14 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
/1.0/kb/catalog/xml/validate:
post:
tags:
- "Catalog"
summary: "Validate a XML catalog"
- description: ""
operationId: "validateCatalogXml"
- consumes:
- - "text/xml"
- produces:
- - "application/json"
parameters:
- in: "body"
name: "body"
@@ -3636,12 +3558,12 @@ paths:
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"200":
description: "successful operation"
@@ -3651,17 +3573,16 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "text/xml"
/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"
@@ -3672,33 +3593,33 @@ paths:
$ref: "#/definitions/InvoiceItem"
- name: "requestedDate"
in: "query"
- required: false
type: "string"
format: "date"
+ required: false
- name: "autoCommit"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
description: "Created credit successfully"
@@ -3714,22 +3635,23 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
/1.0/kb/credits/{creditId}:
get:
tags:
- "Credit"
summary: "Retrieve a credit by id"
- description: ""
operationId: "getCredit"
- produces:
- - "application/json"
parameters:
- name: "creditId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
responses:
"200":
description: "successful operation"
@@ -3743,28 +3665,55 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ /1.0/kb/customFields/{customFieldId}/auditLogsWithHistory:
+ get:
+ tags:
+ - "CustomField"
+ summary: "Retrieve custom field audit logs with history by id"
+ operationId: "getCustomFieldAuditLogsWithHistory"
+ parameters:
+ - name: "customFieldId"
+ in: "path"
+ required: true
+ type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ 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: []
+ produces:
+ - "application/json"
/1.0/kb/customFields/pagination:
get:
tags:
- "CustomField"
summary: "List custom fields"
- description: ""
operationId: "getCustomFields"
- produces:
- - "application/json"
parameters:
- name: "offset"
in: "query"
- required: false
type: "integer"
- default: 0
format: "int64"
+ default: 0
+ required: false
- name: "limit"
in: "query"
- required: false
type: "integer"
- default: 100
format: "int64"
+ default: 100
+ required: false
- name: "audit"
in: "query"
required: false
@@ -3785,15 +3734,14 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
/1.0/kb/customFields/search/{searchKey}:
get:
tags:
- "CustomField"
summary: "Search custom fields"
- description: ""
operationId: "searchCustomFields"
- produces:
- - "application/json"
parameters:
- name: "searchKey"
in: "path"
@@ -3802,16 +3750,16 @@ paths:
pattern: ".*"
- name: "offset"
in: "query"
- required: false
type: "integer"
- default: 0
format: "int64"
+ default: 0
+ required: false
- name: "limit"
in: "query"
- required: false
type: "integer"
- default: 100
format: "int64"
+ default: 100
+ required: false
- name: "audit"
in: "query"
required: false
@@ -3832,69 +3780,39 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/customFields/{customFieldId}/auditLogsWithHistory:
- get:
- tags:
- - "CustomField"
- summary: "Retrieve custom field audit logs with history by id"
- description: ""
- operationId: "getCustomFieldAuditLogsWithHistory"
produces:
- "application/json"
- parameters:
- - name: "customFieldId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
- "404":
- description: "Account not found"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
/1.0/kb/customFields/search:
get:
tags:
- "CustomField"
summary: "Search custom fields by type, name and optional value"
- description: ""
operationId: "searchCustomFieldsByTypeName"
- produces:
- - "application/json"
parameters:
- name: "objectType"
in: "query"
- required: false
type: "string"
+ required: false
- name: "fieldName"
in: "query"
- required: false
type: "string"
+ required: false
- name: "fieldValue"
in: "query"
- required: false
type: "string"
+ required: false
- name: "offset"
in: "query"
- required: false
type: "integer"
- default: 0
format: "int64"
+ default: 0
+ required: false
- name: "limit"
in: "query"
- required: false
type: "integer"
- default: 100
format: "int64"
+ default: 100
+ required: false
- name: "audit"
in: "query"
required: false
@@ -3915,37 +3833,36 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
/1.0/kb/export/{accountId}:
get:
tags:
- "Export"
summary: "Export account data"
- description: ""
operationId: "exportDataForAccount"
- produces:
- - "application/octet-stream"
parameters:
- name: "accountId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"200":
- description: "Success"
+ description: "successful operation"
"400":
description: "Invalid account id supplied"
"404":
@@ -3954,32 +3871,21 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoiceItems/{invoiceItemId}/tags:
+ produces:
+ - "application/octet-stream"
+ /1.0/kb/invoiceItems/{invoiceItemId}/customFields:
get:
tags:
- "InvoiceItem"
- summary: "Retrieve invoice item tags"
- description: ""
- operationId: "getInvoiceItemTags"
- produces:
- - "application/json"
+ summary: "Retrieve invoice item custom fields"
+ operationId: "getInvoiceItemCustomFields"
parameters:
- name: "invoiceItemId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "accountId"
- in: "query"
- required: true
- type: "string"
format: "uuid"
- - name: "includedDeleted"
- in: "query"
- required: false
- type: "boolean"
- default: false
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- name: "audit"
in: "query"
required: false
@@ -3995,102 +3901,139 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/Tag"
+ $ref: "#/definitions/CustomField"
"400":
description: "Invalid invoice item id supplied"
- "404":
- description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- post:
+ produces:
+ - "application/json"
+ put:
tags:
- "InvoiceItem"
- summary: "Add tags to invoice item"
- description: ""
- operationId: "createInvoiceItemTags"
- consumes:
- - "application/json"
+ summary: "Modify custom fields to invoice item"
+ operationId: "modifyInvoiceItemCustomFields"
+ parameters:
+ - name: "invoiceItemId"
+ in: "path"
+ required: true
+ type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - 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"
+ type: "string"
+ required: false
+ - name: "X-Killbill-Comment"
+ in: "header"
+ type: "string"
+ required: false
+ responses:
+ "204":
+ description: "Successful operation"
+ "400":
+ description: "Invalid invoice item id supplied"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ post:
+ tags:
+ - "InvoiceItem"
+ summary: "Add custom fields to invoice item"
+ operationId: "createInvoiceItemCustomFields"
parameters:
- name: "invoiceItemId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
schema:
type: "array"
items:
- type: "string"
- format: "uuid"
+ $ref: "#/definitions/CustomField"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
- description: "Tag created successfully"
+ description: "Custom field created successfully"
schema:
type: "array"
items:
- $ref: "#/definitions/Tag"
+ $ref: "#/definitions/CustomField"
"400":
description: "Invalid invoice item id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
delete:
tags:
- "InvoiceItem"
- summary: "Remove tags from invoice item"
- description: ""
- operationId: "deleteInvoiceItemTags"
- consumes:
- - "application/json"
- produces:
- - "application/json"
+ summary: "Remove custom fields from invoice item"
+ operationId: "deleteInvoiceItemCustomFields"
parameters:
- name: "invoiceItemId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "tagDef"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "customField"
in: "query"
- required: false
type: "array"
items:
type: "string"
format: "uuid"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"204":
description: "Successful operation"
@@ -4100,22 +4043,33 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoiceItems/{invoiceItemId}/customFields:
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/invoiceItems/{invoiceItemId}/tags:
get:
tags:
- "InvoiceItem"
- summary: "Retrieve invoice item custom fields"
- description: ""
- operationId: "getInvoiceItemCustomFields"
- produces:
- - "application/json"
+ summary: "Retrieve invoice item tags"
+ operationId: "getInvoiceItemTags"
parameters:
- name: "invoiceItemId"
in: "path"
required: true
type: "string"
+ format: "uuid"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "accountId"
+ in: "query"
+ required: true
+ type: "string"
format: "uuid"
+ - name: "includedDeleted"
+ in: "query"
+ type: "boolean"
+ default: false
+ required: false
- name: "audit"
in: "query"
required: false
@@ -4131,144 +4085,98 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/CustomField"
+ $ref: "#/definitions/Tag"
"400":
description: "Invalid invoice item id supplied"
+ "404":
+ description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
post:
tags:
- "InvoiceItem"
- summary: "Add custom fields to invoice item"
- description: ""
- operationId: "createInvoiceItemCustomFields"
- consumes:
- - "application/json"
- produces:
- - "application/json"
+ summary: "Add tags to invoice item"
+ operationId: "createInvoiceItemTags"
parameters:
- name: "invoiceItemId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
schema:
type: "array"
items:
- $ref: "#/definitions/CustomField"
+ type: "string"
+ format: "uuid"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
- description: "Custom field created successfully"
+ description: "Tag created successfully"
schema:
type: "array"
items:
- $ref: "#/definitions/CustomField"
+ $ref: "#/definitions/Tag"
"400":
description: "Invalid invoice item id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- put:
- tags:
- - "InvoiceItem"
- summary: "Modify custom fields to invoice item"
- description: ""
- operationId: "modifyInvoiceItemCustomFields"
- consumes:
- - "application/json"
produces:
- "application/json"
- parameters:
- - name: "invoiceItemId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- type: "array"
- items:
- $ref: "#/definitions/CustomField"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
- responses:
- "204":
- description: "Successful operation"
- "400":
- description: "Invalid invoice item id supplied"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
+ consumes:
+ - "application/json"
delete:
tags:
- "InvoiceItem"
- summary: "Remove custom fields from invoice item"
- description: ""
- operationId: "deleteInvoiceItemCustomFields"
- consumes:
- - "application/json"
- produces:
- - "application/json"
+ summary: "Remove tags from invoice item"
+ operationId: "deleteInvoiceItemTags"
parameters:
- name: "invoiceItemId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "customField"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "tagDef"
in: "query"
- required: false
type: "array"
items:
type: "string"
format: "uuid"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"204":
description: "Successful operation"
@@ -4278,22 +4186,23 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
/1.0/kb/invoiceItems/{invoiceItemId}/auditLogsWithHistory:
get:
tags:
- "InvoiceItem"
summary: "Retrieve invoice item audit logs with history by id"
- description: ""
operationId: "getInvoiceItemAuditLogsWithHistory"
- produces:
- - "application/json"
parameters:
- name: "invoiceItemId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
responses:
"200":
description: "successful operation"
@@ -4307,34 +4216,38 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoicePayments/{paymentId}/tags:
+ produces:
+ - "application/json"
+ /1.0/kb/invoicePayments/{paymentId}:
get:
tags:
- "InvoicePayment"
- summary: "Retrieve payment tags"
- description: ""
- operationId: "getInvoicePaymentTags"
- produces:
- - "application/json"
+ summary: "Retrieve a payment by id"
+ operationId: "getInvoicePayment"
parameters:
- name: "paymentId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "includedDeleted"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "withPluginInfo"
in: "query"
+ type: "boolean"
+ default: false
required: false
+ - name: "withAttempts"
+ in: "query"
type: "boolean"
default: false
+ required: false
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "audit"
in: "query"
required: false
@@ -4348,9 +4261,7 @@ paths:
"200":
description: "successful operation"
schema:
- type: "array"
- items:
- $ref: "#/definitions/Tag"
+ $ref: "#/definitions/InvoicePayment"
"400":
description: "Invalid payment id supplied"
"404":
@@ -4359,118 +4270,197 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- post:
+ produces:
+ - "application/json"
+ put:
tags:
- "InvoicePayment"
- summary: "Add tags to payment"
- description: ""
- operationId: "createInvoicePaymentTags"
- consumes:
- - "application/json"
+ summary: "Complete an existing transaction"
+ operationId: "completeInvoicePaymentTransaction"
+ parameters:
+ - name: "paymentId"
+ in: "path"
+ required: true
+ type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/PaymentTransaction"
+ - name: "controlPluginName"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ required: false
+ - name: "pluginProperty"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ required: false
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ type: "string"
+ required: false
+ - name: "X-Killbill-Comment"
+ in: "header"
+ type: "string"
+ required: false
+ responses:
+ "204":
+ description: "Successful operation"
+ "400":
+ description: "Invalid paymentId supplied"
+ "404":
+ description: "Account or payment not found"
+ "402":
+ description: "Transaction declined by gateway"
+ "422":
+ description: "Payment is aborted by a control plugin"
+ "502":
+ description: "Failed to submit payment transaction"
+ "503":
+ description: "Payment in unknown status, failed to receive gateway response"
+ "504":
+ description: "Payment operation timeout"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/invoicePayments/{paymentId}/chargebacks:
+ post:
+ tags:
+ - "InvoicePayment"
+ summary: "Record a chargeback"
+ operationId: "createChargeback"
parameters:
- name: "paymentId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
schema:
- type: "array"
- items:
- type: "string"
- format: "uuid"
+ $ref: "#/definitions/InvoicePaymentTransaction"
+ - name: "pluginProperty"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
- description: "Tag created successfully"
+ description: "Created chargeback successfully"
schema:
- type: "array"
- items:
- $ref: "#/definitions/Tag"
+ $ref: "#/definitions/InvoicePayment"
"400":
description: "Invalid payment id supplied"
+ "404":
+ description: "Account or payment not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- delete:
- tags:
- - "InvoicePayment"
- summary: "Remove tags from payment"
- description: ""
- operationId: "deleteInvoicePaymentTags"
- consumes:
- - "application/json"
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/invoicePayments/{paymentId}/chargebackReversals:
+ post:
+ tags:
+ - "InvoicePayment"
+ summary: "Record a chargebackReversal"
+ operationId: "createChargebackReversal"
parameters:
- name: "paymentId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "tagDef"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/InvoicePaymentTransaction"
+ - name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
- format: "uuid"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
- "204":
- description: "Successful operation"
+ "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: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
/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"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- name: "audit"
in: "query"
required: false
@@ -4493,23 +4483,20 @@ paths:
- 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"
+ put:
+ tags:
+ - "InvoicePayment"
+ summary: "Modify custom fields to payment"
+ operationId: "modifyInvoicePaymentCustomFields"
parameters:
- name: "paymentId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
@@ -4523,42 +4510,37 @@ paths:
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
- "201":
- description: "Custom field created successfully"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/CustomField"
+ "204":
+ description: "Successful operation"
"400":
description: "Invalid payment id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- put:
- tags:
- - "InvoicePayment"
- summary: "Modify custom fields to payment"
- description: ""
- operationId: "modifyInvoicePaymentCustomFields"
- consumes:
- - "application/json"
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ post:
+ tags:
+ - "InvoicePayment"
+ summary: "Add custom fields to payment"
+ operationId: "createInvoicePaymentCustomFields"
parameters:
- name: "paymentId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
@@ -4572,58 +4554,61 @@ paths:
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
- "204":
- description: "Successful operation"
+ "201":
+ description: "Custom field created successfully"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/CustomField"
"400":
description: "Invalid payment id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
delete:
tags:
- "InvoicePayment"
summary: "Remove custom fields from payment"
- description: ""
operationId: "deleteInvoicePaymentCustomFields"
- consumes:
- - "application/json"
- produces:
- - "application/json"
parameters:
- name: "paymentId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- name: "customField"
in: "query"
- required: false
type: "array"
items:
type: "string"
format: "uuid"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"204":
description: "Successful operation"
@@ -4633,39 +4618,35 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoicePayments/{paymentId}:
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/invoicePayments/{paymentId}/tags:
get:
tags:
- "InvoicePayment"
- summary: "Retrieve a payment by id"
- description: ""
- operationId: "getInvoicePayment"
- produces:
- - "application/json"
+ summary: "Retrieve payment tags"
+ operationId: "getInvoicePaymentTags"
parameters:
- name: "paymentId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "withPluginInfo"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "includedDeleted"
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"
+ required: false
- name: "audit"
in: "query"
required: false
@@ -4679,7 +4660,9 @@ paths:
"200":
description: "successful operation"
schema:
- $ref: "#/definitions/InvoicePayment"
+ type: "array"
+ items:
+ $ref: "#/definitions/Tag"
"400":
description: "Invalid payment id supplied"
"404":
@@ -4688,203 +4671,115 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- put:
- tags:
- - "InvoicePayment"
- summary: "Complete an existing transaction"
- description: ""
- operationId: "completeInvoicePaymentTransaction"
- consumes:
- - "application/json"
produces:
- "application/json"
- parameters:
- - name: "paymentId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- $ref: "#/definitions/PaymentTransaction"
- - name: "controlPluginName"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
- responses:
- "204":
- description: "Successful operation"
- "400":
- description: "Invalid paymentId supplied"
- "404":
- description: "Account or payment not found"
- "402":
- description: "Transaction declined by gateway"
- "422":
- description: "Payment is aborted by a control plugin"
- "502":
- description: "Failed to submit payment transaction"
- "503":
- description: "Payment in unknown status, failed to receive gateway response"
- "504":
- description: "Payment operation timeout"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/invoicePayments/{paymentId}/chargebacks:
post:
tags:
- "InvoicePayment"
- summary: "Record a chargeback"
- description: ""
- operationId: "createChargeback"
- consumes:
- - "application/json"
- produces:
- - "application/json"
+ summary: "Add tags to payment"
+ operationId: "createInvoicePaymentTags"
parameters:
- name: "paymentId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
schema:
- $ref: "#/definitions/InvoicePaymentTransaction"
- - 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
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
- description: "Created chargeback successfully"
+ description: "Tag created successfully"
schema:
- $ref: "#/definitions/InvoicePayment"
+ type: "array"
+ items:
+ $ref: "#/definitions/Tag"
"400":
description: "Invalid payment id supplied"
- "404":
- description: "Account or payment not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoicePayments/{paymentId}/chargebackReversals:
- post:
- tags:
- - "InvoicePayment"
- summary: "Record a chargebackReversal"
- description: ""
- operationId: "createChargebackReversal"
- consumes:
- - "application/json"
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ delete:
+ tags:
+ - "InvoicePayment"
+ summary: "Remove tags from payment"
+ operationId: "deleteInvoicePaymentTags"
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"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "tagDef"
in: "query"
- required: false
type: "array"
items:
type: "string"
+ format: "uuid"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
- "201":
- description: "Created chargeback reversal successfully"
- schema:
- $ref: "#/definitions/InvoicePayment"
+ "204":
+ description: "Successful operation"
"400":
description: "Invalid payment id supplied"
- "404":
- description: "Account or payment not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
/1.0/kb/invoicePayments/{paymentId}/refunds:
post:
tags:
- "InvoicePayment"
summary: "Refund a payment, and adjust the invoice if needed"
- description: ""
operationId: "createRefundWithAdjustments"
- consumes:
- - "application/json"
- produces:
- - "application/json"
parameters:
- name: "paymentId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
@@ -4892,33 +4787,33 @@ paths:
$ref: "#/definitions/InvoicePaymentTransaction"
- name: "externalPayment"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "paymentMethodId"
in: "query"
- required: false
type: "string"
format: "uuid"
+ required: false
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
description: "Created refund successfully"
@@ -4932,22 +4827,23 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
/1.0/kb/invoicePayments/{invoicePaymentId}/auditLogsWithHistory:
get:
tags:
- "InvoicePayment"
summary: "Retrieve invoice payment audit logs with history by id"
- description: ""
operationId: "getInvoicePaymentAuditLogsWithHistory"
- produces:
- - "application/json"
parameters:
- name: "invoicePaymentId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
responses:
"200":
description: "successful operation"
@@ -4961,27 +4857,26 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoices/{invoiceId}/tags:
+ produces:
+ - "application/json"
+ /1.0/kb/invoices/{invoiceId}:
get:
tags:
- "Invoice"
- summary: "Retrieve invoice tags"
- description: ""
- operationId: "getInvoiceTags"
- produces:
- - "application/json"
+ summary: "Retrieve an invoice by id"
+ operationId: "getInvoice"
parameters:
- name: "invoiceId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "includedDeleted"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "withChildrenItems"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "audit"
in: "query"
required: false
@@ -4995,9 +4890,7 @@ paths:
"200":
description: "successful operation"
schema:
- type: "array"
- items:
- $ref: "#/definitions/Tag"
+ $ref: "#/definitions/Invoice"
"400":
description: "Invalid invoice id supplied"
"404":
@@ -5006,382 +4899,405 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
post:
tags:
- "Invoice"
- summary: "Add tags to invoice"
- description: ""
- operationId: "createInvoiceTags"
- consumes:
- - "application/json"
- produces:
- - "application/json"
+ summary: "Adjust an invoice item"
+ operationId: "adjustInvoiceItem"
parameters:
- name: "invoiceId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
schema:
- type: "array"
- items:
- type: "string"
- format: "uuid"
+ $ref: "#/definitions/InvoiceItem"
+ - name: "requestedDate"
+ in: "query"
+ type: "string"
+ format: "date"
+ required: false
+ - name: "pluginProperty"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
- description: "Tag created successfully"
+ description: "Created adjustment Successfully"
schema:
- type: "array"
- items:
- $ref: "#/definitions/Tag"
+ $ref: "#/definitions/Invoice"
"400":
- description: "Invalid invoice id 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: []
- delete:
- tags:
- - "Invoice"
- summary: "Remove tags from invoice"
- description: ""
- operationId: "deleteInvoiceTags"
- consumes:
- - "application/json"
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/invoices/{invoiceId}/commitInvoice:
+ put:
+ tags:
+ - "Invoice"
+ summary: "Perform the invoice status transition from DRAFT to COMMITTED"
+ operationId: "commitInvoice"
parameters:
- name: "invoiceId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "tagDef"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- format: "uuid"
- collectionFormat: "multi"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
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}/customFields:
- get:
- tags:
- - "Invoice"
- summary: "Retrieve invoice custom fields"
- description: ""
- operationId: "getInvoiceCustomFields"
produces:
- "application/json"
- parameters:
- - name: "invoiceId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "audit"
- in: "query"
- required: false
- type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
- responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/CustomField"
- "400":
- description: "Invalid invoice id supplied"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
+ consumes:
+ - "application/json"
+ /1.0/kb/invoices/charges/{accountId}:
post:
tags:
- "Invoice"
- summary: "Add custom fields to invoice"
- description: ""
- operationId: "createInvoiceCustomFields"
- consumes:
- - "application/json"
- produces:
- - "application/json"
+ summary: "Create external charge(s)"
+ operationId: "createExternalCharges"
parameters:
- - name: "invoiceId"
+ - name: "accountId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
schema:
type: "array"
items:
- $ref: "#/definitions/CustomField"
+ $ref: "#/definitions/InvoiceItem"
+ - name: "requestedDate"
+ in: "query"
+ type: "string"
+ format: "date"
+ required: false
+ - name: "autoCommit"
+ in: "query"
+ type: "boolean"
+ default: false
+ required: false
+ - name: "pluginProperty"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
- description: "Custom field created successfully"
+ description: "Created external charge Successfully"
schema:
type: "array"
items:
- $ref: "#/definitions/CustomField"
+ $ref: "#/definitions/InvoiceItem"
"400":
- description: "Invalid invoice id supplied"
+ description: "Invalid account id supplied"
+ "404":
+ description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- put:
- tags:
- - "Invoice"
- summary: "Modify custom fields to invoice"
- description: ""
- operationId: "modifyInvoiceCustomFields"
- consumes:
- - "application/json"
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/invoices:
+ post:
+ tags:
+ - "Invoice"
+ summary: "Trigger an invoice generation"
+ operationId: "createFutureInvoice"
parameters:
- - name: "invoiceId"
- in: "path"
+ - name: "accountId"
+ in: "query"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- type: "array"
- items:
- $ref: "#/definitions/CustomField"
+ - name: "targetDate"
+ in: "query"
+ type: "string"
+ format: "date"
+ required: false
+ - name: "pluginProperty"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
- "204":
- description: "Successful operation"
+ "201":
+ description: "Created invoice successfully"
+ schema:
+ $ref: "#/definitions/Invoice"
"400":
- description: "Invalid invoice id supplied"
+ description: "Invalid account id or target datetime supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- delete:
- tags:
- - "Invoice"
- summary: "Remove custom fields from invoice"
- description: ""
- operationId: "deleteInvoiceCustomFields"
- consumes:
- - "application/json"
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/invoices/group:
+ post:
+ tags:
+ - "Invoice"
+ summary: "Trigger an invoice generation"
+ operationId: "createFutureInvoiceGroup"
parameters:
- - name: "invoiceId"
- in: "path"
+ - name: "accountId"
+ in: "query"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "customField"
+ - name: "targetDate"
in: "query"
+ type: "string"
+ format: "date"
required: false
+ - name: "pluginProperty"
+ in: "query"
type: "array"
items:
type: "string"
- format: "uuid"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
- "204":
- description: "Successful operation"
+ "201":
+ description: "Created invoice successfully"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/Invoice"
"400":
- description: "Invalid invoice id supplied"
+ description: "Invalid account id or target datetime supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoices/{invoiceId}/commitInvoice:
- put:
- tags:
- - "Invoice"
- summary: "Perform the invoice status transition from DRAFT to COMMITTED"
- description: ""
- operationId: "commitInvoice"
- consumes:
- - "application/json"
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/invoices/{invoiceId}/payments:
+ get:
+ tags:
+ - "Invoice"
+ summary: "Retrieve payments associated with an invoice"
+ operationId: "getPaymentsForInvoice"
parameters:
- name: "invoiceId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "withPluginInfo"
+ in: "query"
+ type: "boolean"
+ default: false
required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
+ - name: "withAttempts"
+ in: "query"
+ type: "boolean"
+ default: false
+ required: false
+ - name: "audit"
+ in: "query"
required: false
type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
responses:
- "204":
- description: "Successful operation"
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/InvoicePayment"
+ "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:
- put:
- tags:
- - "Invoice"
- summary: "Perform the action of voiding an invoice"
- description: ""
- operationId: "voidInvoice"
- consumes:
- - "application/json"
produces:
- "application/json"
+ post:
+ tags:
+ - "Invoice"
+ summary: "Trigger a payment for invoice"
+ operationId: "createInstantPayment"
parameters:
- name: "invoiceId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "X-Killbill-CreatedBy"
- in: "header"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/InvoicePayment"
+ - name: "externalPayment"
+ in: "query"
+ type: "boolean"
+ default: false
+ required: false
+ - name: "controlPluginName"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ required: false
+ - name: "pluginProperty"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ required: false
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
+ "201":
+ description: "Created payment Successfully"
+ schema:
+ $ref: "#/definitions/InvoicePayment"
"204":
- description: "Successful operation"
+ description: "Nothing to pay for"
"400":
- description: "Invalid invoice id supplied"
+ description: "Invalid account id or invoice id supplied"
"404":
- description: "Invoice not found"
+ description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoices/pagination:
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/invoices/{invoiceId}/customFields:
get:
tags:
- "Invoice"
- summary: "List invoices"
- description: ""
- operationId: "getInvoices"
- produces:
- - "application/json"
+ summary: "Retrieve invoice custom fields"
+ operationId: "getInvoiceCustomFields"
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: "invoiceId"
+ in: "path"
+ required: true
+ type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- name: "audit"
in: "query"
required: false
@@ -5397,181 +5313,170 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/Invoice"
+ $ref: "#/definitions/CustomField"
+ "400":
+ description: "Invalid invoice id supplied"
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"
+ put:
+ tags:
+ - "Invoice"
+ summary: "Modify custom fields to invoice"
+ operationId: "modifyInvoiceCustomFields"
parameters:
- - name: "searchKey"
+ - name: "invoiceId"
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"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - 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"
+ type: "string"
required: false
+ - name: "X-Killbill-Comment"
+ in: "header"
type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
+ required: false
responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/Invoice"
+ "204":
+ description: "Successful operation"
+ "400":
+ description: "Invalid invoice id supplied"
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"
+ consumes:
+ - "application/json"
+ post:
+ tags:
+ - "Invoice"
+ summary: "Add custom fields to invoice"
+ operationId: "createInvoiceCustomFields"
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"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - 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"
+ type: "string"
required: false
+ - name: "X-Killbill-Comment"
+ in: "header"
type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
+ required: false
responses:
- "200":
- description: "successful operation"
+ "201":
+ description: "Custom field created successfully"
schema:
- $ref: "#/definitions/Invoice"
+ type: "array"
+ items:
+ $ref: "#/definitions/CustomField"
"400":
description: "Invalid invoice id supplied"
- "404":
- description: "Invoice not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- post:
- tags:
- - "Invoice"
- summary: "Adjust an invoice item"
- description: ""
- operationId: "adjustInvoiceItem"
- consumes:
- - "application/json"
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ delete:
+ tags:
+ - "Invoice"
+ summary: "Remove custom fields from invoice"
+ operationId: "deleteInvoiceCustomFields"
parameters:
- name: "invoiceId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- $ref: "#/definitions/InvoiceItem"
- - name: "requestedDate"
- in: "query"
- required: false
- type: "string"
- format: "date"
- - name: "pluginProperty"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "customField"
in: "query"
- required: false
type: "array"
items:
type: "string"
+ format: "uuid"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
- "201":
- description: "Created adjustment Successfully"
- schema:
- $ref: "#/definitions/Invoice"
+ "204":
+ description: "Successful operation"
"400":
- description: "Invalid account id, invoice id or invoice item id supplied"
- "404":
- description: "Invoice not found"
+ description: "Invalid invoice id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoices/byNumber/{invoiceNumber}:
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/invoices/{invoiceId}/tags:
get:
tags:
- "Invoice"
- summary: "Retrieve an invoice by number"
- description: ""
- operationId: "getInvoiceByNumber"
- produces:
- - "application/json"
+ summary: "Retrieve invoice tags"
+ operationId: "getInvoiceTags"
parameters:
- - name: "invoiceNumber"
+ - name: "invoiceId"
in: "path"
required: true
- type: "integer"
- pattern: "[0-9]+"
- format: "int32"
- - name: "withChildrenItems"
- in: "query"
- required: false
- type: "boolean"
+ type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "includedDeleted"
+ in: "query"
+ type: "boolean"
default: false
+ required: false
- name: "audit"
in: "query"
required: false
@@ -5585,110 +5490,126 @@ paths:
"200":
description: "successful operation"
schema:
- $ref: "#/definitions/Invoice"
+ type: "array"
+ items:
+ $ref: "#/definitions/Tag"
+ "400":
+ description: "Invalid invoice id supplied"
"404":
description: "Invoice not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoices/{invoiceId}/{invoiceItemId}/cba:
- delete:
- tags:
- - "Invoice"
- summary: "Delete a CBA item"
- description: ""
- operationId: "deleteCBA"
- consumes:
- - "application/json"
produces:
- "application/json"
+ post:
+ tags:
+ - "Invoice"
+ summary: "Add tags to invoice"
+ operationId: "createInvoiceTags"
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"
+ - in: "body"
+ name: "body"
required: true
- type: "string"
- format: "uuid"
+ schema:
+ type: "array"
+ items:
+ type: "string"
+ format: "uuid"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
- "204":
- description: "Successful operation"
+ "201":
+ description: "Tag created successfully"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/Tag"
"400":
- description: "Invalid account id, invoice id or invoice item id supplied"
- "404":
- description: "Account or invoice not found"
+ description: "Invalid invoice id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoices/{invoiceId}/html:
- get:
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
+ delete:
tags:
- "Invoice"
- summary: "Render an invoice as HTML"
- description: ""
- operationId: "getInvoiceAsHTML"
- produces:
- - "text/html"
+ summary: "Remove tags from invoice"
+ operationId: "deleteInvoiceTags"
parameters:
- name: "invoiceId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "tagDef"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ format: "uuid"
+ collectionFormat: "multi"
+ required: false
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ type: "string"
+ required: false
+ - name: "X-Killbill-Comment"
+ in: "header"
+ type: "string"
+ required: false
responses:
- "200":
- description: "successful operation"
- schema:
- type: "string"
- "404":
- description: "Invoice not found"
+ "204":
+ description: "Successful operation"
+ "400":
+ description: "Invalid invoice id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
/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"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
@@ -5698,21 +5619,21 @@ paths:
$ref: "#/definitions/InvoiceItem"
- name: "targetDate"
in: "query"
- required: false
type: "string"
format: "date"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
description: "Created migration invoice successfully"
@@ -5724,24 +5645,23 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoices/charges/{accountId}:
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/invoices/taxes/{accountId}:
post:
tags:
- "Invoice"
- summary: "Create external charge(s)"
- description: ""
- operationId: "createExternalCharges"
- consumes:
- - "application/json"
- produces:
- - "application/json"
+ summary: "Create tax items"
+ operationId: "createTaxItems"
parameters:
- name: "accountId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
@@ -5749,38 +5669,38 @@ paths:
type: "array"
items:
$ref: "#/definitions/InvoiceItem"
- - name: "requestedDate"
+ - name: "autoCommit"
in: "query"
+ type: "boolean"
+ default: false
required: false
+ - name: "requestedDate"
+ in: "query"
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"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
- description: "Created external charge Successfully"
+ description: "Create tax items successfully"
schema:
type: "array"
items:
@@ -5793,70 +5713,73 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoices:
- post:
- tags:
- - "Invoice"
- summary: "Trigger an invoice generation"
- description: ""
- operationId: "createFutureInvoice"
- consumes:
- - "application/json"
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/invoices/{invoiceId}/{invoiceItemId}/cba:
+ delete:
+ tags:
+ - "Invoice"
+ summary: "Delete a CBA item"
+ operationId: "deleteCBA"
parameters:
- - name: "accountId"
- in: "query"
+ - name: "invoiceId"
+ in: "path"
required: true
type: "string"
format: "uuid"
- - name: "targetDate"
- in: "query"
- required: false
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "invoiceItemId"
+ in: "path"
+ required: true
type: "string"
- format: "date"
- - name: "pluginProperty"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - 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
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
- "201":
- description: "Created invoice successfully"
- schema:
- $ref: "#/definitions/Invoice"
+ "204":
+ description: "Successful operation"
"400":
- description: "Invalid account id or target datetime supplied"
+ description: "Invalid account id, invoice id or invoice item id supplied"
+ "404":
+ description: "Account or invoice not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoices/group:
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/invoices/dryRun:
post:
tags:
- "Invoice"
- summary: "Trigger an invoice generation"
- description: ""
- operationId: "createFutureInvoiceGroup"
- consumes:
- - "application/json"
- produces:
- - "application/json"
+ summary: "Generate a dryRun invoice"
+ operationId: "generateDryRunInvoice"
parameters:
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/InvoiceDryRun"
- name: "accountId"
in: "query"
required: true
@@ -5864,441 +5787,257 @@ paths:
format: "uuid"
- name: "targetDate"
in: "query"
- required: false
type: "string"
format: "date"
+ required: false
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
- "201":
- description: "Created invoice successfully"
+ "200":
+ description: "successful operation"
schema:
- type: "array"
- items:
- $ref: "#/definitions/Invoice"
+ $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/{invoiceId}/payments:
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/invoices/catalogTranslation/{locale}:
get:
tags:
- "Invoice"
- summary: "Retrieve payments associated with an invoice"
- description: ""
- operationId: "getPaymentsForInvoice"
- produces:
- - "application/json"
- parameters:
- - name: "invoiceId"
+ summary: "Retrieves the catalog translation for the tenant"
+ operationId: "getCatalogTranslation"
+ parameters:
+ - name: "locale"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "withPluginInfo"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "withAttempts"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "audit"
- in: "query"
- required: false
- type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
+ pattern: ".*"
responses:
"200":
description: "successful operation"
schema:
- type: "array"
- items:
- $ref: "#/definitions/InvoicePayment"
+ type: "string"
"400":
- description: "Invalid invoice id supplied"
+ description: "Invalid locale supplied"
"404":
- description: "Invoice not found"
+ description: "Template not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "text/plain"
post:
tags:
- "Invoice"
- summary: "Trigger a payment for invoice"
- description: ""
- operationId: "createInstantPayment"
- consumes:
- - "application/json"
- produces:
- - "application/json"
+ summary: "Upload the catalog translation for the tenant"
+ operationId: "uploadCatalogTranslation"
parameters:
- - name: "invoiceId"
+ - name: "locale"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
+ pattern: ".*"
- 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
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
- description: "Created payment Successfully"
+ description: "Uploaded catalog translation 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/taxes/{accountId}:
- post:
+ produces:
+ - "text/plain"
+ consumes:
+ - "text/plain"
+ /1.0/kb/invoices/{invoiceId}/html:
+ get:
tags:
- "Invoice"
- summary: "Create tax items"
- description: ""
- operationId: "createTaxItems"
- consumes:
- - "application/json"
- produces:
- - "application/json"
+ summary: "Render an invoice as HTML"
+ operationId: "getInvoiceAsHTML"
parameters:
- - name: "accountId"
+ - name: "invoiceId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- type: "array"
- items:
- $ref: "#/definitions/InvoiceItem"
- - name: "autoCommit"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "requestedDate"
- in: "query"
- required: false
- type: "string"
- format: "date"
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "X-Killbill-CreatedBy"
- in: "header"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ type: "string"
+ "404":
+ description: "Invoice not found"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ produces:
+ - "text/html"
+ /1.0/kb/invoices/{invoiceId}/auditLogsWithHistory:
+ get:
+ tags:
+ - "Invoice"
+ summary: "Retrieve invoice audit logs with history by id"
+ operationId: "getInvoiceAuditLogsWithHistory"
+ parameters:
+ - 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"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
responses:
- "201":
- description: "Create tax items successfully"
+ "200":
+ description: "successful operation"
schema:
type: "array"
items:
- $ref: "#/definitions/InvoiceItem"
- "400":
- description: "Invalid account id supplied"
+ $ref: "#/definitions/AuditLog"
"404":
- description: "Account not found"
+ description: "Invoice not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoices/dryRun:
- post:
- tags:
- - "Invoice"
- summary: "Generate a dryRun invoice"
- description: ""
- operationId: "generateDryRunInvoice"
- consumes:
- - "application/json"
produces:
- "application/json"
+ /1.0/kb/invoices/byItemId/{itemId}:
+ get:
+ tags:
+ - "Invoice"
+ summary: "Retrieve an invoice by invoice item id"
+ operationId: "getInvoiceByItemId"
parameters:
- - in: "body"
- name: "body"
- required: true
- schema:
- $ref: "#/definitions/InvoiceDryRun"
- - name: "accountId"
- in: "query"
+ - name: "itemId"
+ in: "path"
required: true
type: "string"
format: "uuid"
- - name: "targetDate"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "withChildrenItems"
in: "query"
+ type: "boolean"
+ default: false
required: false
- type: "string"
- format: "date"
- - name: "pluginProperty"
+ - 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/catalogTranslation/{locale}:
+ produces:
+ - "application/json"
+ /1.0/kb/invoices/byNumber/{invoiceNumber}:
get:
tags:
- "Invoice"
- summary: "Retrieves the catalog translation for the tenant"
- description: ""
- operationId: "getCatalogTranslation"
- produces:
- - "text/plain"
+ summary: "Retrieve an invoice by number"
+ operationId: "getInvoiceByNumber"
parameters:
- - name: "locale"
+ - name: "invoiceNumber"
in: "path"
required: true
+ type: "integer"
+ format: "int32"
+ - name: "withChildrenItems"
+ in: "query"
+ type: "boolean"
+ default: false
+ required: false
+ - name: "audit"
+ in: "query"
+ required: false
type: "string"
- pattern: ".*"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
responses:
"200":
description: "successful operation"
schema:
- type: "string"
- "400":
- description: "Invalid locale supplied"
- "404":
- description: "Template not found"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- post:
- tags:
- - "Invoice"
- summary: "Upload the catalog translation for the tenant"
- description: ""
- operationId: "uploadCatalogTranslation"
- consumes:
- - "text/plain"
- produces:
- - "text/plain"
- parameters:
- - name: "locale"
- in: "path"
- required: true
- type: "string"
- pattern: ".*"
- - in: "body"
- name: "body"
- required: true
- schema:
- type: "string"
- - name: "deleteIfExists"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
- responses:
- "201":
- description: "Uploaded catalog translation Successfully"
- schema:
- type: "string"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/invoices/{invoiceId}/auditLogsWithHistory:
- get:
- tags:
- - "Invoice"
- summary: "Retrieve invoice audit logs with history by id"
- description: ""
- operationId: "getInvoiceAuditLogsWithHistory"
- produces:
- - "application/json"
- parameters:
- - name: "invoiceId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
+ $ref: "#/definitions/Invoice"
"404":
description: "Invoice not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoices/byItemId/{itemId}:
- get:
- tags:
- - "Invoice"
- summary: "Retrieve an invoice by invoice item id"
- description: ""
- operationId: "getInvoiceByItemId"
produces:
- "application/json"
- parameters:
- - name: "itemId"
- in: "path"
- 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"
- "404":
- description: "Invoice not found"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
/1.0/kb/invoices/manualPayTemplate/{locale}:
get:
tags:
- "Invoice"
summary: "Retrieves the manualPay invoice template for the tenant"
- description: ""
operationId: "getInvoiceMPTemplate"
- produces:
- - "text/html"
parameters:
- name: "locale"
in: "path"
@@ -6316,16 +6055,14 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "text/html"
/1.0/kb/invoices/template:
get:
tags:
- "Invoice"
summary: "Retrieves the invoice template for the tenant"
- description: ""
operationId: "getInvoiceTemplate"
- produces:
- - "text/html"
- parameters: []
responses:
"200":
description: "successful operation"
@@ -6337,16 +6074,13 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "text/html"
post:
tags:
- "Invoice"
summary: "Upload the invoice template for the tenant"
- description: ""
operationId: "uploadInvoiceTemplate"
- consumes:
- - "text/html"
- produces:
- - "text/html"
parameters:
- in: "body"
name: "body"
@@ -6355,21 +6089,21 @@ paths:
type: "string"
- name: "deleteIfExists"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
description: "Uploaded invoice template Successfully"
@@ -6379,15 +6113,16 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "text/html"
+ consumes:
+ - "text/html"
/1.0/kb/invoices/translation/{locale}:
get:
tags:
- "Invoice"
summary: "Retrieves the invoice translation for the tenant"
- description: ""
operationId: "getInvoiceTranslation"
- produces:
- - "text/plain"
parameters:
- name: "locale"
in: "path"
@@ -6407,16 +6142,13 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "text/plain"
post:
tags:
- "Invoice"
summary: "Upload the invoice translation for the tenant"
- description: ""
operationId: "uploadInvoiceTranslation"
- consumes:
- - "text/plain"
- produces:
- - "text/plain"
parameters:
- name: "locale"
in: "path"
@@ -6430,21 +6162,21 @@ paths:
type: "string"
- name: "deleteIfExists"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
description: "Uploaded invoice translation Successfully"
@@ -6454,22 +6186,64 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "text/plain"
+ consumes:
+ - "text/plain"
+ /1.0/kb/invoices/pagination:
+ get:
+ tags:
+ - "Invoice"
+ summary: "List invoices"
+ operationId: "getInvoices"
+ parameters:
+ - name: "offset"
+ in: "query"
+ type: "integer"
+ format: "int64"
+ default: 0
+ required: false
+ - name: "limit"
+ in: "query"
+ type: "integer"
+ format: "int64"
+ default: 100
+ required: false
+ - name: "audit"
+ in: "query"
+ required: false
+ type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/Invoice"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ produces:
+ - "application/json"
/1.0/kb/invoices/{groupId}/group:
get:
tags:
- "Invoice"
summary: "Retrieve a set of invoices by group id"
- description: ""
operationId: "getInvoicesGroup"
- produces:
- - "application/json"
parameters:
- name: "groupId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- name: "accountId"
in: "query"
required: true
@@ -6477,9 +6251,9 @@ paths:
format: "uuid"
- name: "withChildrenItems"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "audit"
in: "query"
required: false
@@ -6502,17 +6276,60 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ /1.0/kb/invoices/search/{searchKey}:
+ get:
+ tags:
+ - "Invoice"
+ summary: "Search invoices"
+ operationId: "searchInvoices"
+ parameters:
+ - name: "searchKey"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: ".*"
+ - name: "offset"
+ in: "query"
+ type: "integer"
+ format: "int64"
+ default: 0
+ required: false
+ - name: "limit"
+ in: "query"
+ type: "integer"
+ format: "int64"
+ default: 100
+ required: false
+ - name: "audit"
+ in: "query"
+ required: false
+ type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/Invoice"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ produces:
+ - "application/json"
/1.0/kb/invoices/manualPayTemplate:
post:
tags:
- "Invoice"
summary: "Upload the manualPay invoice template for the tenant"
- description: ""
operationId: "uploadInvoiceMPTemplate"
- consumes:
- - "text/html"
- produces:
- - "text/html"
parameters:
- in: "body"
name: "body"
@@ -6521,21 +6338,21 @@ paths:
type: "string"
- name: "deleteIfExists"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"200":
description: "successful operation"
@@ -6545,16 +6362,56 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "text/html"
+ consumes:
+ - "text/html"
+ /1.0/kb/invoices/{invoiceId}/voidInvoice:
+ put:
+ tags:
+ - "Invoice"
+ summary: "Perform the action of voiding an invoice"
+ operationId: "voidInvoice"
+ parameters:
+ - name: "invoiceId"
+ in: "path"
+ required: true
+ type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ type: "string"
+ required: false
+ - name: "X-Killbill-Comment"
+ in: "header"
+ type: "string"
+ required: false
+ responses:
+ "204":
+ description: "Successful operation"
+ "400":
+ description: "Invalid invoice id supplied"
+ "404":
+ description: "Invoice not found"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
/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"
@@ -6564,16 +6421,13 @@ paths:
$ref: "#/definitions/NodeInfo"
security:
- basicAuth: []
+ produces:
+ - "application/json"
post:
tags:
- "NodesInfo"
summary: "Trigger a node command"
- description: ""
operationId: "triggerNodeCommand"
- consumes:
- - "application/json"
- produces:
- - "application/json"
parameters:
- in: "body"
name: "body"
@@ -6582,21 +6436,21 @@ paths:
$ref: "#/definitions/NodeCommand"
- name: "localNodeOnly"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"202":
description: "Successful operation"
@@ -6604,16 +6458,16 @@ paths:
description: "Invalid node command supplied"
security:
- basicAuth: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
/1.0/kb/overdue:
get:
tags:
- "Overdue"
summary: "Retrieve the overdue config as JSON"
- description: ""
operationId: "getOverdueConfigJson"
- produces:
- - "application/json"
- parameters: []
responses:
"200":
description: "successful operation"
@@ -6623,16 +6477,13 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
post:
tags:
- "Overdue"
summary: "Upload the full overdue config as JSON"
- description: ""
operationId: "uploadOverdueConfigJson"
- consumes:
- - "application/json"
- produces:
- - "application/json"
parameters:
- in: "body"
name: "body"
@@ -6645,12 +6496,12 @@ paths:
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
description: "Successfully uploaded overdue config"
@@ -6662,16 +6513,16 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
/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"
@@ -6681,14 +6532,13 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "text/xml"
post:
tags:
- "Overdue"
summary: "Upload the full overdue config as XML"
- description: ""
operationId: "uploadOverdueConfigXml"
- consumes:
- - "text/xml"
parameters:
- in: "body"
name: "body"
@@ -6701,12 +6551,12 @@ paths:
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
description: "Successfully uploaded overdue config"
@@ -6718,196 +6568,192 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/paymentGateways/hosted/form/{accountId}:
+ consumes:
+ - "text/xml"
+ /1.0/kb/paymentGateways/hosted/form:
post:
tags:
- "PaymentGateway"
- summary: "Generate form data to redirect the customer to the gateway"
- description: ""
- operationId: "buildFormDescriptor"
- consumes:
- - "application/json"
- produces:
- - "application/json"
+ summary: "Combo API to generate form data to redirect the customer to the gateway"
+ operationId: "buildComboFormDescriptor"
parameters:
- - name: "accountId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- in: "body"
name: "body"
required: true
schema:
- $ref: "#/definitions/HostedPaymentPageFields"
- - name: "paymentMethodId"
- in: "query"
- required: false
- type: "string"
- format: "uuid"
+ $ref: "#/definitions/ComboHostedPaymentPage"
- name: "controlPluginName"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/HostedPaymentPageFormDescriptor"
- "404":
- description: "Account not found"
+ "400":
+ description: "Invalid data for Account or PaymentMethod"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/paymentGateways/notification/{pluginName}:
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/paymentGateways/hosted/form/{accountId}:
post:
tags:
- "PaymentGateway"
- summary: "Process a gateway notification"
- description: "The response is built by the appropriate plugin"
- operationId: "processNotification"
- consumes:
- - "*/*"
- produces:
- - "application/json"
+ summary: "Generate form data to redirect the customer to the gateway"
+ operationId: "buildFormDescriptor"
parameters:
- - name: "pluginName"
+ - name: "accountId"
in: "path"
required: true
type: "string"
- pattern: ".*"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
schema:
- type: "string"
- - name: "controlPluginName"
+ $ref: "#/definitions/HostedPaymentPageFields"
+ - name: "paymentMethodId"
in: "query"
+ type: "string"
+ format: "uuid"
required: false
+ - name: "controlPluginName"
+ in: "query"
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"200":
- description: "Successful"
+ description: "successful operation"
+ schema:
+ $ref: "#/definitions/HostedPaymentPageFormDescriptor"
+ "404":
+ description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/paymentGateways/hosted/form:
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/paymentGateways/notification/{pluginName}:
post:
tags:
- "PaymentGateway"
- summary: "Combo API to generate form data to redirect the customer to the gateway"
- description: ""
- operationId: "buildComboFormDescriptor"
- consumes:
- - "application/json"
- produces:
- - "application/json"
+ summary: "Process a gateway notification"
+ operationId: "processNotification"
parameters:
+ - name: "pluginName"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: ".*"
- in: "body"
name: "body"
required: true
schema:
- $ref: "#/definitions/ComboHostedPaymentPage"
+ type: "string"
- name: "controlPluginName"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"200":
- description: "successful operation"
- schema:
- $ref: "#/definitions/HostedPaymentPageFormDescriptor"
- "400":
- description: "Invalid data for Account or PaymentMethod"
+ description: "Successful"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "*/*"
/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"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- name: "audit"
in: "query"
required: false
@@ -6930,23 +6776,20 @@ paths:
- 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"
+ put:
+ tags:
+ - "PaymentMethod"
+ summary: "Modify custom fields to payment method"
+ operationId: "modifyPaymentMethodCustomFields"
parameters:
- name: "paymentMethodId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
@@ -6960,42 +6803,37 @@ paths:
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
- "201":
- description: "Custom field created successfully"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/CustomField"
+ "204":
+ description: "Successful operation"
"400":
description: "Invalid payment method id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- put:
- tags:
- - "PaymentMethod"
- summary: "Modify custom fields to payment method"
- description: ""
- operationId: "modifyPaymentMethodCustomFields"
- consumes:
- - "application/json"
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ post:
+ tags:
+ - "PaymentMethod"
+ summary: "Add custom fields to payment method"
+ operationId: "createPaymentMethodCustomFields"
parameters:
- name: "paymentMethodId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
@@ -7009,58 +6847,61 @@ paths:
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
- "204":
- description: "Successful operation"
+ "201":
+ description: "Custom field created successfully"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/CustomField"
"400":
description: "Invalid payment method id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
delete:
tags:
- "PaymentMethod"
summary: "Remove custom fields from payment method"
- description: ""
operationId: "deletePaymentMethodCustomFields"
- consumes:
- - "application/json"
- produces:
- - "application/json"
parameters:
- name: "paymentMethodId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- name: "customField"
in: "query"
- required: false
type: "array"
items:
type: "string"
format: "uuid"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"204":
description: "Successful operation"
@@ -7070,160 +6911,40 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/paymentMethods/pagination:
- get:
- tags:
- - "PaymentMethod"
- summary: "List payment methods"
- description: ""
- operationId: "getPaymentMethods"
produces:
- "application/json"
- parameters:
- - name: "offset"
- in: "query"
- required: false
- type: "integer"
- default: 0
- format: "int64"
- - name: "limit"
- in: "query"
- required: false
- type: "integer"
- default: 100
- format: "int64"
- - name: "pluginName"
- in: "query"
- required: false
- type: "string"
- - name: "withPluginInfo"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "audit"
- in: "query"
- required: false
- type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
- responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/PaymentMethod"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/paymentMethods/search/{searchKey}:
- get:
- tags:
- - "PaymentMethod"
- summary: "Search payment methods"
- description: ""
- operationId: "searchPaymentMethods"
- produces:
+ consumes:
- "application/json"
- parameters:
- - name: "searchKey"
- in: "path"
- required: true
- type: "string"
- pattern: ".*"
- - name: "offset"
- in: "query"
- required: false
- type: "integer"
- default: 0
- format: "int64"
- - name: "limit"
- in: "query"
- required: false
- type: "integer"
- default: 100
- format: "int64"
- - name: "pluginName"
- in: "query"
- required: false
- type: "string"
- - name: "withPluginInfo"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "audit"
- in: "query"
- required: false
- type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
- responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/PaymentMethod"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
/1.0/kb/paymentMethods/{paymentMethodId}:
get:
tags:
- "PaymentMethod"
summary: "Retrieve a payment method by id"
- description: ""
operationId: "getPaymentMethod"
- produces:
- - "application/json"
parameters:
- name: "paymentMethodId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- name: "includedDeleted"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "withPluginInfo"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "audit"
in: "query"
required: false
@@ -7246,50 +6967,49 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
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"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- name: "deleteDefaultPmWithAutoPayOff"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "forceDefaultPmDeletion"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"204":
description: "Successful operation"
@@ -7301,22 +7021,21 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
/1.0/kb/paymentMethods/{paymentMethodId}/auditLogsWithHistory:
get:
tags:
- "PaymentMethod"
summary: "Retrieve payment method audit logs with history by id"
- description: ""
operationId: "getPaymentMethodAuditLogsWithHistory"
- produces:
- - "application/json"
parameters:
- name: "paymentMethodId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
responses:
"200":
description: "successful operation"
@@ -7330,15 +7049,14 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
/1.0/kb/paymentMethods:
get:
tags:
- "PaymentMethod"
summary: "Retrieve a payment method by external key"
- description: ""
operationId: "getPaymentMethodByKey"
- produces:
- - "application/json"
parameters:
- name: "externalKey"
in: "query"
@@ -7346,21 +7064,21 @@ paths:
type: "string"
- name: "includedDeleted"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "withPluginInfo"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "audit"
in: "query"
required: false
@@ -7381,27 +7099,43 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/{paymentId}/tags:
- get:
- tags:
- - "Payment"
- summary: "Retrieve payment payment tags"
- description: ""
- operationId: "getPaymentTags"
produces:
- "application/json"
+ /1.0/kb/paymentMethods/pagination:
+ get:
+ tags:
+ - "PaymentMethod"
+ summary: "List payment methods"
+ operationId: "getPaymentMethods"
parameters:
- - name: "paymentId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "includedDeleted"
+ - name: "offset"
+ in: "query"
+ type: "integer"
+ format: "int64"
+ default: 0
+ required: false
+ - name: "limit"
+ in: "query"
+ type: "integer"
+ format: "int64"
+ default: 100
+ required: false
+ - name: "pluginName"
in: "query"
+ type: "string"
required: false
+ - name: "withPluginInfo"
+ in: "query"
type: "boolean"
default: false
+ required: false
+ - name: "pluginProperty"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ required: false
- name: "audit"
in: "query"
required: false
@@ -7417,127 +7151,53 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/Tag"
- "400":
- description: "Invalid payment id supplied"
- "404":
- description: "Invoice not found"
+ $ref: "#/definitions/PaymentMethod"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- post:
- tags:
- - "Payment"
- summary: "Add tags to payment payment"
- description: ""
- operationId: "createPaymentTags"
- consumes:
- - "application/json"
produces:
- "application/json"
+ /1.0/kb/paymentMethods/search/{searchKey}:
+ get:
+ tags:
+ - "PaymentMethod"
+ summary: "Search payment methods"
+ operationId: "searchPaymentMethods"
parameters:
- - name: "paymentId"
+ - name: "searchKey"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- type: "array"
- items:
- type: "string"
- format: "uuid"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
+ pattern: ".*"
+ - name: "offset"
+ in: "query"
+ type: "integer"
+ format: "int64"
+ default: 0
required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
+ - name: "limit"
+ in: "query"
+ type: "integer"
+ format: "int64"
+ default: 100
required: false
+ - name: "pluginName"
+ in: "query"
type: "string"
- responses:
- "201":
- description: "Tag created successfully"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/Tag"
- "400":
- description: "Invalid payment id supplied"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- delete:
- tags:
- - "Payment"
- summary: "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"
+ required: false
+ - name: "withPluginInfo"
in: "query"
+ type: "boolean"
+ default: false
required: false
+ - name: "pluginProperty"
+ in: "query"
type: "array"
items:
type: "string"
- format: "uuid"
collectionFormat: "multi"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
required: false
- type: "string"
- responses:
- "204":
- description: "Successful operation"
- "400":
- description: "Invalid payment id supplied"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/payments/{paymentId}/customFields:
- get:
- tags:
- - "Payment"
- summary: "Retrieve payment custom fields"
- description: ""
- operationId: "getPaymentCustomFields"
- 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
@@ -7553,186 +7213,117 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/CustomField"
- "400":
- description: "Invalid payment id supplied"
+ $ref: "#/definitions/PaymentMethod"
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
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
- responses:
- "201":
- description: "Custom field created successfully"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/CustomField"
- "400":
- description: "Invalid payment id supplied"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- put:
+ /1.0/kb/payments/cancelScheduledPaymentTransaction:
+ delete:
tags:
- "Payment"
- summary: "Modify custom fields to payment"
- description: ""
- operationId: "modifyPaymentCustomFields"
- consumes:
- - "application/json"
- produces:
- - "application/json"
+ summary: "Cancels a scheduled payment attempt retry"
+ operationId: "cancelScheduledPaymentTransactionByExternalKey"
parameters:
- - name: "paymentId"
- in: "path"
+ - name: "transactionExternalKey"
+ in: "query"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- type: "array"
- items:
- $ref: "#/definitions/CustomField"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"204":
description: "Successful operation"
"400":
- description: "Invalid payment id supplied"
+ description: "Invalid paymentTransactionExternalKey supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/payments/{paymentTransactionId}/cancelScheduledPaymentTransaction:
delete:
tags:
- "Payment"
- summary: "Remove custom fields from payment payment"
- description: ""
- operationId: "deletePaymentCustomFields"
- consumes:
- - "application/json"
- produces:
- - "application/json"
+ summary: "Cancels a scheduled payment attempt retry"
+ operationId: "cancelScheduledPaymentTransactionById"
parameters:
- - name: "paymentId"
+ - name: "paymentTransactionId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "customField"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- format: "uuid"
- collectionFormat: "multi"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"204":
description: "Successful operation"
"400":
- description: "Invalid payment id supplied"
+ description: "Invalid paymentTransactionId supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
/1.0/kb/payments/{paymentId}:
get:
tags:
- "Payment"
summary: "Retrieve a payment by id"
- description: ""
operationId: "getPayment"
- produces:
- - "application/json"
parameters:
- name: "paymentId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- name: "withPluginInfo"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "withAttempts"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "audit"
in: "query"
required: false
@@ -7755,23 +7346,20 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- post:
- tags:
- - "Payment"
- summary: "Capture an existing authorization"
- description: ""
- operationId: "captureAuthorization"
- consumes:
- - "application/json"
produces:
- "application/json"
+ put:
+ tags:
+ - "Payment"
+ summary: "Complete an existing transaction"
+ operationId: "completeTransaction"
parameters:
- name: "paymentId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
@@ -7779,35 +7367,33 @@ paths:
$ref: "#/definitions/PaymentTransaction"
- name: "controlPluginName"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
- "201":
- description: "Payment transaction created successfully"
- schema:
- $ref: "#/definitions/Payment"
+ "204":
+ description: "Successful operation"
"400":
description: "Invalid paymentId supplied"
"404":
@@ -7826,23 +7412,22 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- put:
- tags:
- - "Payment"
- summary: "Complete an existing transaction"
- description: ""
- operationId: "completeTransaction"
- consumes:
- - "application/json"
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ post:
+ tags:
+ - "Payment"
+ summary: "Capture an existing authorization"
+ operationId: "captureAuthorization"
parameters:
- name: "paymentId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
@@ -7850,33 +7435,35 @@ paths:
$ref: "#/definitions/PaymentTransaction"
- name: "controlPluginName"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
- "204":
- description: "Successful operation"
+ "201":
+ description: "Payment transaction created successfully"
+ schema:
+ $ref: "#/definitions/Payment"
"400":
description: "Invalid paymentId supplied"
"404":
@@ -7895,23 +7482,22 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
delete:
tags:
- "Payment"
summary: "Void an existing payment"
- description: ""
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"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
@@ -7919,30 +7505,30 @@ paths:
$ref: "#/definitions/PaymentTransaction"
- name: "controlPluginName"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"204":
description: "Successful operation"
@@ -7964,37 +7550,38 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
/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
+ required: false
- name: "withAttempts"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "externalKey"
in: "query"
required: true
type: "string"
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "audit"
in: "query"
required: false
@@ -8015,16 +7602,13 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- post:
- tags:
- - "Payment"
- summary: "Capture an existing authorization"
- description: ""
- operationId: "captureAuthorizationByExternalKey"
- consumes:
- - "application/json"
produces:
- "application/json"
+ put:
+ tags:
+ - "Payment"
+ summary: "Complete an existing transaction"
+ operationId: "completeTransactionByExternalKey"
parameters:
- in: "body"
name: "body"
@@ -8033,35 +7617,33 @@ paths:
$ref: "#/definitions/PaymentTransaction"
- name: "controlPluginName"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
- "201":
- description: "Payment transaction created successfully"
- schema:
- $ref: "#/definitions/Payment"
+ "204":
+ description: "Successful operation"
"404":
description: "Account or payment not found"
"402":
@@ -8078,16 +7660,15 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- put:
- tags:
- - "Payment"
- summary: "Complete an existing transaction"
- description: ""
- operationId: "completeTransactionByExternalKey"
- consumes:
- - "application/json"
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ post:
+ tags:
+ - "Payment"
+ summary: "Capture an existing authorization"
+ operationId: "captureAuthorizationByExternalKey"
parameters:
- in: "body"
name: "body"
@@ -8096,33 +7677,35 @@ paths:
$ref: "#/definitions/PaymentTransaction"
- name: "controlPluginName"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
- "204":
- description: "Successful operation"
+ "201":
+ description: "Payment transaction created successfully"
+ schema:
+ $ref: "#/definitions/Payment"
"404":
description: "Account or payment not found"
"402":
@@ -8139,16 +7722,15 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
delete:
tags:
- "Payment"
summary: "Void an existing payment"
- description: ""
operationId: "voidPaymentByExternalKey"
- consumes:
- - "application/json"
- produces:
- - "application/json"
parameters:
- in: "body"
name: "body"
@@ -8157,30 +7739,30 @@ paths:
$ref: "#/definitions/PaymentTransaction"
- name: "controlPluginName"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"204":
description: "Successful operation"
@@ -8200,269 +7782,124 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/pagination:
- get:
- tags:
- - "Payment"
- summary: "Get payments"
- description: ""
- operationId: "getPayments"
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/payments/{paymentId}/chargebacks:
+ post:
+ tags:
+ - "Payment"
+ summary: "Record a chargeback"
+ operationId: "chargebackPayment"
parameters:
- - name: "offset"
- in: "query"
- required: false
- type: "integer"
- default: 0
- format: "int64"
- - name: "limit"
- in: "query"
- required: false
- type: "integer"
- default: 100
- format: "int64"
- - name: "pluginName"
- in: "query"
- required: false
+ - name: "paymentId"
+ in: "path"
+ required: true
type: "string"
- - name: "withPluginInfo"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "withAttempts"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/PaymentTransaction"
+ - name: "controlPluginName"
in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
required: false
- type: "boolean"
- default: false
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
- - name: "audit"
- in: "query"
required: false
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ type: "string"
+ required: false
+ - name: "X-Killbill-Comment"
+ in: "header"
+ type: "string"
+ required: false
responses:
- "200":
- description: "successful operation"
+ "201":
+ description: "Payment transaction created successfully"
schema:
- type: "array"
- items:
- $ref: "#/definitions/Payment"
+ $ref: "#/definitions/Payment"
+ "400":
+ description: "Invalid paymentId supplied"
+ "404":
+ description: "Account or payment not found"
+ "402":
+ description: "Transaction declined by gateway"
+ "422":
+ description: "Payment is aborted by a control plugin"
+ "502":
+ description: "Failed to submit payment transaction"
+ "503":
+ description: "Payment in unknown status, failed to receive gateway response"
+ "504":
+ description: "Payment operation timeout"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/search/{searchKey}:
- get:
- tags:
- - "Payment"
- summary: "Search payments"
- description: ""
- operationId: "searchPayments"
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/payments/chargebacks:
+ post:
+ tags:
+ - "Payment"
+ summary: "Record a chargeback"
+ operationId: "chargebackPaymentByExternalKey"
parameters:
- - name: "searchKey"
- in: "path"
+ - in: "body"
+ name: "body"
required: true
- type: "string"
- pattern: ".*"
- - name: "offset"
+ schema:
+ $ref: "#/definitions/PaymentTransaction"
+ - name: "controlPluginName"
in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
required: false
- type: "integer"
- default: 0
- format: "int64"
- - name: "limit"
+ - name: "pluginProperty"
in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
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/cancelScheduledPaymentTransaction:
- delete:
- tags:
- - "Payment"
- summary: "Cancels a scheduled payment attempt retry"
- description: ""
- operationId: "cancelScheduledPaymentTransactionByExternalKey"
- consumes:
- - "application/json"
- produces:
- - "application/json"
- parameters:
- - name: "transactionExternalKey"
- in: "query"
- required: true
- type: "string"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
- responses:
- "204":
- description: "Successful operation"
- "400":
- description: "Invalid paymentTransactionExternalKey supplied"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/payments/{paymentTransactionId}/cancelScheduledPaymentTransaction:
- delete:
- tags:
- - "Payment"
- summary: "Cancels a scheduled payment attempt retry"
- description: ""
- operationId: "cancelScheduledPaymentTransactionById"
- consumes:
- - "application/json"
- produces:
- - "application/json"
- parameters:
- - name: "paymentTransactionId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
required: false
- type: "string"
- name: "X-Killbill-Comment"
in: "header"
- required: false
- type: "string"
- responses:
- "204":
- description: "Successful operation"
- "400":
- description: "Invalid paymentTransactionId supplied"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/payments/{paymentId}/chargebacks:
- post:
- tags:
- - "Payment"
- summary: "Record a chargeback"
- description: ""
- operationId: "chargebackPayment"
- consumes:
- - "application/json"
- produces:
- - "application/json"
- parameters:
- - name: "paymentId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- $ref: "#/definitions/PaymentTransaction"
- - name: "controlPluginName"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
required: false
- type: "string"
responses:
"201":
description: "Payment transaction created successfully"
schema:
$ref: "#/definitions/Payment"
- "400":
- description: "Invalid paymentId supplied"
"404":
description: "Account or payment not found"
"402":
@@ -8479,18 +7916,23 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/chargebacks:
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/payments/{paymentId}/chargebackReversals:
post:
tags:
- "Payment"
- summary: "Record a chargeback"
- description: ""
- operationId: "chargebackPaymentByExternalKey"
- consumes:
- - "application/json"
- produces:
- - "application/json"
+ summary: "Record a chargeback reversal"
+ operationId: "chargebackReversalPayment"
parameters:
+ - name: "paymentId"
+ in: "path"
+ required: true
+ type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
@@ -8498,35 +7940,37 @@ paths:
$ref: "#/definitions/PaymentTransaction"
- name: "controlPluginName"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
description: "Payment transaction created successfully"
schema:
$ref: "#/definitions/Payment"
+ "400":
+ description: "Invalid paymentId supplied"
"404":
description: "Account or payment not found"
"402":
@@ -8543,24 +7987,17 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/{paymentId}/chargebackReversals:
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/payments/chargebackReversals:
post:
tags:
- "Payment"
summary: "Record a chargeback reversal"
- description: ""
- operationId: "chargebackReversalPayment"
- consumes:
- - "application/json"
- produces:
- - "application/json"
+ operationId: "chargebackReversalPaymentByExternalKey"
parameters:
- - name: "paymentId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- in: "body"
name: "body"
required: true
@@ -8568,37 +8005,35 @@ paths:
$ref: "#/definitions/PaymentTransaction"
- name: "controlPluginName"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
description: "Payment transaction created successfully"
schema:
$ref: "#/definitions/Payment"
- "400":
- description: "Invalid paymentId supplied"
"404":
description: "Account or payment not found"
"402":
@@ -8615,56 +8050,49 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/chargebackReversals:
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/payments/combo:
post:
tags:
- "Payment"
- summary: "Record a chargeback reversal"
- description: ""
- operationId: "chargebackReversalPaymentByExternalKey"
- consumes:
- - "application/json"
- produces:
- - "application/json"
+ summary: "Combo api to create a new payment transaction on a existing (or not)\
+ \ account "
+ operationId: "createComboPayment"
parameters:
- in: "body"
name: "body"
required: true
schema:
- $ref: "#/definitions/PaymentTransaction"
+ $ref: "#/definitions/ComboPaymentTransaction"
- 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"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
description: "Payment transaction created successfully"
schema:
$ref: "#/definitions/Payment"
- "404":
- description: "Account or payment not found"
+ "400":
+ description: "Invalid data for Account or PaymentMethod"
"402":
description: "Transaction declined by gateway"
"422":
@@ -8679,598 +8107,619 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/combo:
- post:
- tags:
- - "Payment"
- summary: "Combo api to create a new payment transaction on a existing (or not)\
- \ account "
- description: ""
- operationId: "createComboPayment"
- consumes:
- - "application/json"
produces:
- "application/json"
- parameters:
- - in: "body"
- name: "body"
- required: true
- schema:
- $ref: "#/definitions/ComboPaymentTransaction"
- - name: "controlPluginName"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
- responses:
- "201":
- description: "Payment transaction created successfully"
- schema:
- $ref: "#/definitions/Payment"
- "400":
- description: "Invalid data for Account or PaymentMethod"
- "402":
- description: "Transaction declined by gateway"
- "422":
- description: "Payment is aborted by a control plugin"
- "502":
- description: "Failed to submit payment transaction"
- "503":
- description: "Payment in unknown status, failed to receive gateway response"
- "504":
- description: "Payment operation timeout"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/payments/attempts/{paymentAttemptId}/auditLogsWithHistory:
+ consumes:
+ - "application/json"
+ /1.0/kb/payments/{paymentId}/customFields:
get:
tags:
- "Payment"
- summary: "Retrieve payment attempt audit logs with history by id"
- description: ""
- operationId: "getPaymentAttemptAuditLogsWithHistory"
- produces:
- - "application/json"
+ summary: "Retrieve payment custom fields"
+ operationId: "getPaymentCustomFields"
parameters:
- - name: "paymentAttemptId"
+ - name: "paymentId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "audit"
+ in: "query"
+ required: false
+ type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
responses:
"200":
description: "successful operation"
schema:
type: "array"
items:
- $ref: "#/definitions/AuditLog"
- "404":
- description: "Account not found"
+ $ref: "#/definitions/CustomField"
+ "400":
+ description: "Invalid payment id supplied"
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"
+ put:
+ tags:
+ - "Payment"
+ summary: "Modify custom fields to payment"
+ operationId: "modifyPaymentCustomFields"
parameters:
- name: "paymentId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - 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"
+ type: "string"
+ required: false
+ - name: "X-Killbill-Comment"
+ in: "header"
+ type: "string"
+ required: false
responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
- "404":
- description: "Account not found"
+ "204":
+ description: "Successful operation"
+ "400":
+ description: "Invalid payment id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/{paymentId}/refunds:
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
post:
tags:
- "Payment"
- summary: "Refund an existing payment"
- description: ""
- operationId: "refundPayment"
- consumes:
- - "application/json"
- produces:
- - "application/json"
+ summary: "Add custom fields to payment"
+ operationId: "createPaymentCustomFields"
parameters:
- name: "paymentId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
schema:
- $ref: "#/definitions/PaymentTransaction"
- - name: "controlPluginName"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
+ type: "array"
+ items:
+ $ref: "#/definitions/CustomField"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
- description: "Payment transaction created successfully"
+ description: "Custom field created successfully"
schema:
- $ref: "#/definitions/Payment"
+ type: "array"
+ items:
+ $ref: "#/definitions/CustomField"
"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: []
- /1.0/kb/payments/refunds:
- post:
- tags:
- - "Payment"
- summary: "Refund an existing payment"
- description: ""
- operationId: "refundPaymentByExternalKey"
- consumes:
- - "application/json"
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ delete:
+ tags:
+ - "Payment"
+ summary: "Remove custom fields from payment payment"
+ operationId: "deletePaymentCustomFields"
parameters:
- - in: "body"
- name: "body"
+ - name: "paymentId"
+ in: "path"
required: true
- schema:
- $ref: "#/definitions/PaymentTransaction"
- - name: "controlPluginName"
+ type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "customField"
in: "query"
- required: false
type: "array"
items:
type: "string"
+ format: "uuid"
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"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
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"
+ "204":
+ description: "Successful operation"
+ "400":
+ description: "Invalid payment id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/pluginsInfo:
- get:
- tags:
- - "PluginInfo"
- summary: "Retrieve the list of registered plugins"
- description: ""
- operationId: "getPluginsInfo"
produces:
- "application/json"
- parameters: []
- responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/PluginInfo"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/security/permissions:
+ consumes:
+ - "application/json"
+ /1.0/kb/payments/{paymentId}/tags:
get:
tags:
- - "Security"
- summary: "List user permissions"
- description: ""
- operationId: "getCurrentUserPermissions"
- produces:
- - "application/json"
- parameters: []
+ - "Payment"
+ summary: "Retrieve payment payment tags"
+ operationId: "getPaymentTags"
+ parameters:
+ - name: "paymentId"
+ in: "path"
+ required: true
+ type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "includedDeleted"
+ in: "query"
+ type: "boolean"
+ default: false
+ required: false
+ - name: "audit"
+ in: "query"
+ required: false
+ type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
responses:
"200":
description: "successful operation"
schema:
type: "array"
items:
- type: "string"
+ $ref: "#/definitions/Tag"
+ "400":
+ description: "Invalid payment id supplied"
+ "404":
+ description: "Invoice not found"
security:
- basicAuth: []
- /1.0/kb/security/users:
- post:
- tags:
- - "Security"
- summary: "Add a new user with roles (to make api requests)"
- description: ""
- operationId: "addUserRoles"
- consumes:
- - "application/json"
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
produces:
- "application/json"
+ post:
+ tags:
+ - "Payment"
+ summary: "Add tags to payment payment"
+ operationId: "createPaymentTags"
parameters:
+ - name: "paymentId"
+ in: "path"
+ required: true
+ type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
schema:
- $ref: "#/definitions/UserRoles"
+ type: "array"
+ items:
+ type: "string"
+ format: "uuid"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
- description: "User role created successfully"
+ description: "Tag created successfully"
schema:
- $ref: "#/definitions/UserRoles"
+ type: "array"
+ items:
+ $ref: "#/definitions/Tag"
+ "400":
+ description: "Invalid payment id supplied"
security:
- basicAuth: []
- /1.0/kb/security/users/{username}/password:
- put:
- tags:
- - "Security"
- summary: "Update a user password"
- description: ""
- operationId: "updateUserPassword"
- consumes:
- - "application/json"
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ delete:
+ tags:
+ - "Payment"
+ summary: "Remove tags from payment payment"
+ operationId: "deletePaymentTags"
parameters:
- - name: "username"
+ - name: "paymentId"
in: "path"
required: true
type: "string"
- pattern: ".*"
- - in: "body"
- name: "body"
- required: true
- schema:
- $ref: "#/definitions/UserRoles"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "tagDef"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ format: "uuid"
+ collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"204":
description: "Successful operation"
+ "400":
+ description: "Invalid payment id supplied"
security:
- basicAuth: []
- /1.0/kb/security/users/{username}/roles:
- get:
- tags:
- - "Security"
- summary: "Get roles associated to a user"
- description: ""
- operationId: "getUserRoles"
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/payments/attempts/{paymentAttemptId}/auditLogsWithHistory:
+ get:
+ tags:
+ - "Payment"
+ summary: "Retrieve payment attempt audit logs with history by id"
+ operationId: "getPaymentAttemptAuditLogsWithHistory"
parameters:
- - name: "username"
+ - name: "paymentAttemptId"
in: "path"
required: true
type: "string"
- pattern: ".*"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
responses:
"200":
description: "successful operation"
schema:
- $ref: "#/definitions/UserRoles"
+ type: "array"
+ items:
+ $ref: "#/definitions/AuditLog"
"404":
- description: "The user does not exist or has been inactivated"
+ description: "Account not found"
security:
- basicAuth: []
- put:
- tags:
- - "Security"
- summary: "Update roles associated to a user"
- description: ""
- operationId: "updateUserRoles"
- consumes:
- - "application/json"
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
produces:
- "application/json"
+ /1.0/kb/payments/{paymentId}/auditLogsWithHistory:
+ get:
+ tags:
+ - "Payment"
+ summary: "Retrieve payment audit logs with history by id"
+ operationId: "getPaymentAuditLogsWithHistory"
parameters:
- - name: "username"
+ - name: "paymentId"
in: "path"
required: true
type: "string"
- pattern: ".*"
- - in: "body"
- name: "body"
- required: true
- schema:
- $ref: "#/definitions/UserRoles"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
responses:
- "204":
- description: "Successful operation"
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/AuditLog"
+ "404":
+ description: "Account not found"
security:
- basicAuth: []
- /1.0/kb/security/users/{username}:
- delete:
- tags:
- - "Security"
- summary: "Invalidate an existing user"
- description: ""
- operationId: "invalidateUser"
- consumes:
- - "application/json"
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
produces:
- "application/json"
+ /1.0/kb/payments/pagination:
+ get:
+ tags:
+ - "Payment"
+ summary: "Get payments"
+ operationId: "getPayments"
parameters:
- - name: "username"
- in: "path"
- required: true
- type: "string"
- pattern: ".*"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
+ - name: "offset"
+ in: "query"
+ type: "integer"
+ format: "int64"
+ default: 0
+ required: false
+ - name: "limit"
+ in: "query"
+ type: "integer"
+ format: "int64"
+ default: 100
required: false
+ - name: "pluginName"
+ in: "query"
type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
+ required: false
+ - name: "withPluginInfo"
+ in: "query"
+ type: "boolean"
+ default: false
+ required: false
+ - name: "withAttempts"
+ in: "query"
+ type: "boolean"
+ default: false
+ required: false
+ - name: "pluginProperty"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ required: false
+ - name: "audit"
+ in: "query"
required: false
type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
responses:
- "204":
- description: "Successful operation"
- security:
- - basicAuth: []
- /1.0/kb/security/roles:
- post:
- tags:
- - "Security"
- summary: "Add a new role definition)"
- description: ""
- operationId: "addRoleDefinition"
- consumes:
- - "application/json"
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/Payment"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
produces:
- "application/json"
+ /1.0/kb/payments/{paymentId}/refunds:
+ post:
+ tags:
+ - "Payment"
+ summary: "Refund an existing payment"
+ operationId: "refundPayment"
parameters:
+ - name: "paymentId"
+ in: "path"
+ required: true
+ type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
schema:
- $ref: "#/definitions/RoleDefinition"
+ $ref: "#/definitions/PaymentTransaction"
+ - name: "controlPluginName"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ required: false
+ - name: "pluginProperty"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
- description: "Role definition created successfully"
+ description: "Payment transaction created successfully"
schema:
- $ref: "#/definitions/RoleDefinition"
+ $ref: "#/definitions/Payment"
+ "400":
+ description: "Invalid paymentId supplied"
+ "404":
+ description: "Account or payment not found"
+ "402":
+ description: "Transaction declined by gateway"
+ "422":
+ description: "Payment is aborted by a control plugin"
+ "502":
+ description: "Failed to submit payment transaction"
+ "503":
+ description: "Payment in unknown status, failed to receive gateway response"
+ "504":
+ description: "Payment operation timeout"
security:
- basicAuth: []
- put:
- tags:
- - "Security"
- summary: "Update a new role definition)"
- description: ""
- operationId: "updateRoleDefinition"
- consumes:
- - "application/json"
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/payments/refunds:
+ post:
+ tags:
+ - "Payment"
+ summary: "Refund an existing payment"
+ operationId: "refundPaymentByExternalKey"
parameters:
- in: "body"
name: "body"
required: true
schema:
- $ref: "#/definitions/RoleDefinition"
+ $ref: "#/definitions/PaymentTransaction"
+ - name: "controlPluginName"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ required: false
+ - name: "pluginProperty"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
- type: "string"
- responses:
- "204":
- 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: ".*"
+ required: false
responses:
- "200":
- description: "successful operation"
+ "201":
+ description: "Payment transaction created successfully"
schema:
- $ref: "#/definitions/RoleDefinition"
+ $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: []
- /1.0/kb/security/subject:
- get:
- tags:
- - "Security"
- summary: "Get user information"
- description: ""
- operationId: "getCurrentUserSubject"
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
produces:
- "application/json"
- parameters: []
- responses:
- "200":
- description: "successful operation"
- schema:
- $ref: "#/definitions/Subject"
- security:
- - basicAuth: []
- /1.0/kb/subscriptions/{subscriptionId}/tags:
+ consumes:
+ - "application/json"
+ /1.0/kb/payments/search/{searchKey}:
get:
tags:
- - "Subscription"
- summary: "Retrieve subscription tags"
- description: ""
- operationId: "getSubscriptionTags"
- produces:
- - "application/json"
+ - "Payment"
+ summary: "Search payments"
+ operationId: "searchPayments"
parameters:
- - name: "subscriptionId"
+ - name: "searchKey"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "includedDeleted"
+ pattern: ".*"
+ - name: "offset"
in: "query"
+ type: "integer"
+ format: "int64"
+ default: 0
+ required: false
+ - name: "limit"
+ in: "query"
+ type: "integer"
+ format: "int64"
+ default: 100
+ required: false
+ - name: "withPluginInfo"
+ in: "query"
+ type: "boolean"
+ default: false
required: false
+ - name: "withAttempts"
+ in: "query"
type: "boolean"
default: false
+ required: false
+ - name: "pluginName"
+ in: "query"
+ type: "string"
+ required: false
+ - name: "pluginProperty"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ required: false
- name: "audit"
in: "query"
required: false
@@ -9286,295 +8735,347 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/Tag"
- "400":
- description: "Invalid subscription id supplied"
- "404":
- description: "Subscription not found"
+ $ref: "#/definitions/Payment"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- post:
+ produces:
+ - "application/json"
+ /1.0/kb/pluginsInfo:
+ get:
tags:
- - "Subscription"
- operationId: "createSubscriptionTags"
- consumes:
+ - "PluginInfo"
+ summary: "Retrieve the list of registered plugins"
+ operationId: "getPluginsInfo"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/PluginInfo"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ produces:
- "application/json"
+ /1.0/kb/security/roles:
+ get:
+ tags:
+ - "Security"
+ summary: "List all active role definitions"
+ operationId: "getAvailableRoles"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/RoleDefinition"
+ security:
+ - basicAuth: []
produces:
- "application/json"
+ put:
+ tags:
+ - "Security"
+ summary: "Update a new role definition)"
+ operationId: "updateRoleDefinition"
parameters:
- - name: "subscriptionId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- in: "body"
name: "body"
required: true
schema:
- type: "array"
- items:
- type: "string"
- format: "uuid"
+ $ref: "#/definitions/RoleDefinition"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
- "201":
- description: "Tag created successfully"
- "400":
- description: "Invalid subscription id supplied"
+ "204":
+ description: "Successful operation"
security:
- basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- delete:
- tags:
- - "Subscription"
- summary: "Remove tags from subscription"
- description: ""
- operationId: "deleteSubscriptionTags"
- consumes:
- - "application/json"
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ post:
+ tags:
+ - "Security"
+ summary: "Add a new role definition)"
+ operationId: "addRoleDefinition"
parameters:
- - name: "subscriptionId"
- in: "path"
+ - in: "body"
+ name: "body"
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"
+ schema:
+ $ref: "#/definitions/RoleDefinition"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
- "204":
- description: "Successful operation"
- "400":
- description: "Invalid subscription id supplied"
+ "201":
+ description: "Role definition created successfully"
+ schema:
+ $ref: "#/definitions/RoleDefinition"
security:
- basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/subscriptions/{subscriptionId}/customFields:
- get:
- tags:
- - "Subscription"
- summary: "Retrieve subscription custom fields"
- description: ""
- operationId: "getSubscriptionCustomFields"
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/security/users:
+ post:
+ tags:
+ - "Security"
+ summary: "Add a new user with roles (to make api requests)"
+ operationId: "addUserRoles"
parameters:
- - name: "subscriptionId"
- in: "path"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/UserRoles"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "audit"
- in: "query"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ type: "string"
required: false
+ - name: "X-Killbill-Comment"
+ in: "header"
type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
+ required: false
+ responses:
+ "201":
+ description: "User role created successfully"
+ schema:
+ $ref: "#/definitions/UserRoles"
+ security:
+ - basicAuth: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/security/permissions:
+ get:
+ tags:
+ - "Security"
+ summary: "List user permissions"
+ operationId: "getCurrentUserPermissions"
responses:
"200":
description: "successful operation"
schema:
type: "array"
items:
- $ref: "#/definitions/CustomField"
- "400":
- description: "Invalid subscription id supplied"
+ type: "string"
security:
- basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- post:
+ produces:
+ - "application/json"
+ /1.0/kb/security/subject:
+ get:
tags:
- - "Subscription"
- summary: "Add custom fields to subscription"
- description: ""
- operationId: "createSubscriptionCustomFields"
- consumes:
+ - "Security"
+ summary: "Get user information"
+ operationId: "getCurrentUserSubject"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ $ref: "#/definitions/Subject"
+ security:
+ - basicAuth: []
+ produces:
- "application/json"
+ /1.0/kb/security/roles/{role}:
+ get:
+ tags:
+ - "Security"
+ summary: "Get role definition"
+ operationId: "getRoleDefinition"
+ parameters:
+ - name: "role"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: ".*"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ $ref: "#/definitions/RoleDefinition"
+ security:
+ - basicAuth: []
produces:
- "application/json"
+ /1.0/kb/security/users/{username}/roles:
+ get:
+ tags:
+ - "Security"
+ summary: "Get roles associated to a user"
+ operationId: "getUserRoles"
parameters:
- - name: "subscriptionId"
+ - name: "username"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
+ pattern: ".*"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ $ref: "#/definitions/UserRoles"
+ "404":
+ description: "The user does not exist or has been inactivated"
+ security:
+ - basicAuth: []
+ produces:
+ - "application/json"
+ put:
+ tags:
+ - "Security"
+ summary: "Update roles associated to a user"
+ operationId: "updateUserRoles"
+ parameters:
+ - name: "username"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: ".*"
- in: "body"
name: "body"
required: true
schema:
- type: "array"
- items:
- $ref: "#/definitions/CustomField"
+ $ref: "#/definitions/UserRoles"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
- "201":
- description: "Custom field created successfully"
- "400":
- description: "Invalid subscription id supplied"
+ "204":
+ description: "Successful operation"
security:
- basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- put:
- tags:
- - "Subscription"
- summary: "Modify custom fields to subscription"
- description: ""
- operationId: "modifySubscriptionCustomFields"
- consumes:
- - "application/json"
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/security/users/{username}:
+ delete:
+ tags:
+ - "Security"
+ summary: "Invalidate an existing user"
+ operationId: "invalidateUser"
parameters:
- - name: "subscriptionId"
+ - name: "username"
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"
+ pattern: ".*"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"204":
description: "Successful operation"
- "400":
- description: "Invalid subscription id supplied"
security:
- basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- delete:
- tags:
- - "Subscription"
- summary: "Remove custom fields from subscription"
- description: ""
- operationId: "deleteSubscriptionCustomFields"
- consumes:
- - "application/json"
produces:
- "application/json"
- parameters:
- - name: "subscriptionId"
- in: "path"
+ consumes:
+ - "application/json"
+ /1.0/kb/security/users/{username}/password:
+ put:
+ tags:
+ - "Security"
+ summary: "Update a user password"
+ operationId: "updateUserPassword"
+ parameters:
+ - name: "username"
+ in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "customField"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- format: "uuid"
- collectionFormat: "multi"
+ pattern: ".*"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/UserRoles"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"204":
description: "Successful operation"
- "400":
- description: "Invalid subscription id supplied"
security:
- basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
/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"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
@@ -9582,28 +9083,28 @@ paths:
$ref: "#/definitions/BlockingState"
- name: "requestedDate"
in: "query"
- required: false
type: "string"
format: "date"
+ required: false
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
description: "Blocking state created successfully"
@@ -9619,22 +9120,21 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ consumes:
+ - "application/json"
/1.0/kb/subscriptions/{subscriptionId}:
get:
tags:
- "Subscription"
summary: "Retrieve a subscription by id"
- description: ""
operationId: "getSubscription"
- produces:
- - "application/json"
parameters:
- name: "subscriptionId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- name: "audit"
in: "query"
required: false
@@ -9657,23 +9157,20 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
put:
tags:
- "Subscription"
summary: "Change entitlement plan"
- description: ""
operationId: "changeSubscriptionPlan"
- consumes:
- - "application/json"
- produces:
- - "application/json"
parameters:
- name: "subscriptionId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
@@ -9681,48 +9178,48 @@ paths:
$ref: "#/definitions/Subscription"
- name: "requestedDate"
in: "query"
- required: false
type: "string"
format: "date"
+ required: false
- name: "callCompletion"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "callTimeoutSec"
in: "query"
- required: false
type: "integer"
- default: 3
format: "int64"
+ default: 3
+ required: false
- name: "billingPolicy"
in: "query"
- required: false
type: "string"
enum:
- "START_OF_TERM"
- "END_OF_TERM"
- "IMMEDIATE"
- "ILLEGAL"
+ required: false
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"204":
description: "Successful operation"
@@ -9734,77 +9231,78 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
delete:
tags:
- "Subscription"
summary: "Cancel an entitlement plan"
- description: ""
operationId: "cancelSubscriptionPlan"
- produces:
- - "application/json"
parameters:
- name: "subscriptionId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- name: "requestedDate"
in: "query"
- required: false
type: "string"
format: "date"
+ required: false
- name: "callCompletion"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "callTimeoutSec"
in: "query"
- required: false
type: "integer"
- default: 5
format: "int64"
+ default: 5
+ required: false
- name: "entitlementPolicy"
in: "query"
- required: false
type: "string"
enum:
- "IMMEDIATE"
- "END_OF_TERM"
+ required: false
- name: "billingPolicy"
in: "query"
- required: false
type: "string"
enum:
- "START_OF_TERM"
- "END_OF_TERM"
- "IMMEDIATE"
- "ILLEGAL"
+ required: false
- name: "useRequestedDateForBilling"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"204":
description: "Successful operation"
@@ -9816,15 +9314,14 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
/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"
@@ -9850,16 +9347,13 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
post:
tags:
- "Subscription"
summary: "Create a subscription"
- description: ""
operationId: "createSubscription"
- consumes:
- - "application/json"
- produces:
- - "application/json"
parameters:
- in: "body"
name: "body"
@@ -9868,59 +9362,59 @@ paths:
$ref: "#/definitions/Subscription"
- name: "entitlementDate"
in: "query"
- required: false
type: "string"
format: "date"
+ required: false
- name: "billingDate"
in: "query"
- required: false
type: "string"
format: "date"
+ required: false
- name: "renameKeyIfExistsAndUnused"
in: "query"
- required: false
type: "boolean"
default: true
+ required: false
- name: "migrated"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "skipResponse"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "callCompletion"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "callTimeoutSec"
in: "query"
- required: false
type: "integer"
- default: 3
format: "int64"
+ default: 3
+ required: false
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
description: "Subscription created successfully"
@@ -9930,1018 +9424,1099 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/subscriptions/createSubscriptionWithAddOns:
- post:
- tags:
- - "Subscription"
- summary: "Create an entitlement with addOn products"
- description: ""
- operationId: "createSubscriptionWithAddOns"
+ produces:
+ - "application/json"
consumes:
- "application/json"
+ /1.0/kb/subscriptions/{subscriptionId}/customFields:
+ get:
+ tags:
+ - "Subscription"
+ summary: "Retrieve subscription custom fields"
+ operationId: "getSubscriptionCustomFields"
+ parameters:
+ - name: "subscriptionId"
+ in: "path"
+ required: true
+ type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "audit"
+ in: "query"
+ required: false
+ type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/CustomField"
+ "400":
+ description: "Invalid subscription id supplied"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
produces:
- "application/json"
+ put:
+ tags:
+ - "Subscription"
+ summary: "Modify custom fields to subscription"
+ operationId: "modifySubscriptionCustomFields"
parameters:
+ - name: "subscriptionId"
+ in: "path"
+ required: true
+ type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
schema:
type: "array"
items:
- $ref: "#/definitions/Subscription"
- - name: "entitlementDate"
- in: "query"
- required: false
- type: "string"
- format: "date"
- - name: "billingDate"
- in: "query"
- required: false
- type: "string"
- format: "date"
- - name: "migrated"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "skipResponse"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "renameKeyIfExistsAndUnused"
- in: "query"
- required: false
- type: "boolean"
- default: true
- - name: "callCompletion"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "callTimeoutSec"
- in: "query"
- required: false
- type: "integer"
- default: 3
- format: "int64"
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
+ $ref: "#/definitions/CustomField"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
- "201":
- description: "Subscriptions created successfully"
- schema:
- $ref: "#/definitions/Bundle"
+ "204":
+ description: "Successful operation"
+ "400":
+ description: "Invalid subscription id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/subscriptions/createSubscriptionsWithAddOns:
- post:
- tags:
- - "Subscription"
- summary: "Create multiple entitlements with addOn products"
- description: ""
- operationId: "createSubscriptionsWithAddOns"
- consumes:
- - "application/json"
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ post:
+ tags:
+ - "Subscription"
+ summary: "Add custom fields to subscription"
+ operationId: "createSubscriptionCustomFields"
parameters:
+ - name: "subscriptionId"
+ in: "path"
+ required: true
+ type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
schema:
type: "array"
items:
- $ref: "#/definitions/BulkSubscriptionsBundle"
- - name: "entitlementDate"
- in: "query"
- required: false
- type: "string"
- format: "date"
- - name: "billingDate"
- in: "query"
- required: false
- type: "string"
- format: "date"
- - name: "renameKeyIfExistsAndUnused"
- in: "query"
- required: false
- type: "boolean"
- default: true
- - name: "migrated"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "skipResponse"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "callCompletion"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "callTimeoutSec"
- in: "query"
- required: false
- type: "integer"
- default: 3
- format: "int64"
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
+ $ref: "#/definitions/CustomField"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
- description: "Subscriptions created successfully"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/Bundle"
+ description: "Custom field created successfully"
+ "400":
+ description: "Invalid subscription id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/subscriptions/{subscriptionId}/auditLogsWithHistory:
- get:
- tags:
- - "Subscription"
- summary: "Retrieve subscription audit logs with history by id"
- description: ""
- operationId: "getSubscriptionAuditLogsWithHistory"
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ delete:
+ tags:
+ - "Subscription"
+ summary: "Remove custom fields from subscription"
+ operationId: "deleteSubscriptionCustomFields"
parameters:
- name: "subscriptionId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "customField"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ format: "uuid"
+ collectionFormat: "multi"
+ required: false
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ type: "string"
+ required: false
+ - name: "X-Killbill-Comment"
+ in: "header"
+ type: "string"
+ required: false
responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
- "404":
- description: "Subscription not found"
+ "204":
+ description: "Successful operation"
+ "400":
+ description: "Invalid subscription id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/subscriptions/events/{eventId}/auditLogsWithHistory:
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/subscriptions/{subscriptionId}/tags:
get:
tags:
- "Subscription"
- summary: "Retrieve subscription event audit logs with history by id"
- description: ""
- operationId: "getSubscriptionEventAuditLogsWithHistory"
- produces:
- - "application/json"
+ summary: "Retrieve subscription tags"
+ operationId: "getSubscriptionTags"
parameters:
- - name: "eventId"
+ - name: "subscriptionId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "includedDeleted"
+ in: "query"
+ type: "boolean"
+ default: false
+ required: false
+ - name: "audit"
+ in: "query"
+ required: false
+ type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
responses:
"200":
description: "successful operation"
schema:
type: "array"
items:
- $ref: "#/definitions/AuditLog"
+ $ref: "#/definitions/Tag"
+ "400":
+ description: "Invalid subscription id supplied"
"404":
- description: "Subscription event not found"
+ description: "Subscription not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/subscriptions/{subscriptionId}/uncancel:
- put:
- tags:
- - "Subscription"
- summary: "Un-cancel an entitlement"
- description: ""
- operationId: "uncancelSubscriptionPlan"
produces:
- "application/json"
+ post:
+ tags:
+ - "Subscription"
+ operationId: "createSubscriptionTags"
parameters:
- name: "subscriptionId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ type: "array"
+ items:
+ type: "string"
+ format: "uuid"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
- "204":
- description: "Successful operation"
+ "201":
+ description: "Tag created successfully"
"400":
description: "Invalid subscription id supplied"
- "404":
- description: "Entitlement not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/subscriptions/{subscriptionId}/undoChangePlan:
- put:
- tags:
- - "Subscription"
- summary: "Undo a pending change plan on an entitlement"
- description: ""
- operationId: "undoChangeSubscriptionPlan"
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ delete:
+ tags:
+ - "Subscription"
+ summary: "Remove tags from subscription"
+ operationId: "deleteSubscriptionTags"
parameters:
- name: "subscriptionId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "pluginProperty"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "tagDef"
in: "query"
- required: false
type: "array"
items:
type: "string"
+ format: "uuid"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"204":
description: "Successful operation"
"400":
description: "Invalid subscription id supplied"
- "404":
- description: "Entitlement not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/subscriptions/{subscriptionId}/bcd:
- put:
- tags:
- - "Subscription"
- summary: "Update the BCD associated to a subscription"
- description: ""
- operationId: "updateSubscriptionBCD"
- consumes:
- - "application/json"
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/subscriptions/createSubscriptionWithAddOns:
+ post:
+ tags:
+ - "Subscription"
+ summary: "Create an entitlement with addOn products"
+ operationId: "createSubscriptionWithAddOns"
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"
+ type: "array"
+ items:
+ $ref: "#/definitions/Subscription"
+ - name: "entitlementDate"
in: "query"
- required: false
type: "string"
format: "date"
- - name: "forceNewBcdWithPastEffectiveDate"
+ required: false
+ - name: "billingDate"
in: "query"
+ type: "string"
+ format: "date"
required: false
+ - name: "migrated"
+ in: "query"
type: "boolean"
default: false
+ required: false
+ - name: "skipResponse"
+ in: "query"
+ type: "boolean"
+ default: false
+ required: false
+ - name: "renameKeyIfExistsAndUnused"
+ in: "query"
+ type: "boolean"
+ default: true
+ required: false
+ - name: "callCompletion"
+ in: "query"
+ type: "boolean"
+ default: false
+ required: false
+ - name: "callTimeoutSec"
+ in: "query"
+ type: "integer"
+ format: "int64"
+ default: 3
+ required: false
+ - name: "pluginProperty"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
- "204":
- description: "Successful operation"
- "400":
- description: "Invalid entitlement supplied"
+ "201":
+ description: "Subscriptions created successfully"
+ schema:
+ $ref: "#/definitions/Bundle"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/subscriptions/{subscriptionId}/quantity:
- put:
- tags:
- - "Subscription"
- summary: "Update the quantity associated to a subscription"
- description: ""
- operationId: "updateSubscriptionQuantity"
- consumes:
- - "application/json"
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/subscriptions/createSubscriptionsWithAddOns:
+ post:
+ tags:
+ - "Subscription"
+ summary: "Create multiple entitlements with addOn products"
+ operationId: "createSubscriptionsWithAddOns"
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"
+ type: "array"
+ items:
+ $ref: "#/definitions/BulkSubscriptionsBundle"
+ - name: "entitlementDate"
in: "query"
+ type: "string"
+ format: "date"
required: false
+ - name: "billingDate"
+ in: "query"
type: "string"
format: "date"
- - name: "forceNewQuantityWithPastEffectiveDate"
+ required: false
+ - name: "renameKeyIfExistsAndUnused"
+ in: "query"
+ type: "boolean"
+ default: true
+ required: false
+ - name: "migrated"
+ in: "query"
+ type: "boolean"
+ default: false
+ required: false
+ - name: "skipResponse"
in: "query"
+ type: "boolean"
+ default: false
required: false
+ - name: "callCompletion"
+ in: "query"
type: "boolean"
default: false
+ required: false
+ - name: "callTimeoutSec"
+ in: "query"
+ type: "integer"
+ format: "int64"
+ default: 3
+ required: false
+ - name: "pluginProperty"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
- "204":
- description: "Successful operation"
- "400":
- description: "Invalid entitlement supplied"
+ "201":
+ description: "Subscriptions created successfully"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/Bundle"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/tagDefinitions/{tagDefinitionId}:
- get:
- tags:
- - "TagDefinition"
- summary: "Retrieve a tag definition"
- description: ""
- operationId: "getTagDefinition"
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/subscriptions/{subscriptionId}/auditLogsWithHistory:
+ get:
+ tags:
+ - "Subscription"
+ summary: "Retrieve subscription audit logs with history by id"
+ operationId: "getSubscriptionAuditLogsWithHistory"
parameters:
- - name: "tagDefinitionId"
+ - name: "subscriptionId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "audit"
- in: "query"
- required: false
- type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
responses:
"200":
description: "successful operation"
schema:
- $ref: "#/definitions/TagDefinition"
- "400":
- description: "Invalid tagDefinitionId supplied"
+ type: "array"
+ items:
+ $ref: "#/definitions/AuditLog"
+ "404":
+ description: "Subscription not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- delete:
- tags:
- - "TagDefinition"
- summary: "Delete a tag definition"
- description: ""
- operationId: "deleteTagDefinition"
produces:
- "application/json"
+ /1.0/kb/subscriptions/events/{eventId}/auditLogsWithHistory:
+ get:
+ tags:
+ - "Subscription"
+ summary: "Retrieve subscription event audit logs with history by id"
+ operationId: "getSubscriptionEventAuditLogsWithHistory"
parameters:
- - name: "tagDefinitionId"
+ - name: "eventId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
- responses:
- "204":
- description: "Successful operation"
- "400":
- description: "Invalid tagDefinitionId supplied"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/tagDefinitions:
- get:
- tags:
- - "TagDefinition"
- summary: "List tag definitions"
- description: ""
- operationId: "getTagDefinitions"
- produces:
- - "application/json"
- parameters:
- - name: "audit"
- in: "query"
- required: false
- type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
responses:
"200":
description: "successful operation"
schema:
type: "array"
items:
- $ref: "#/definitions/TagDefinition"
+ $ref: "#/definitions/AuditLog"
+ "404":
+ description: "Subscription event not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- post:
- tags:
- - "TagDefinition"
- summary: "Create a tag definition"
- description: ""
- operationId: "createTagDefinition"
- consumes:
- - "application/json"
produces:
- "application/json"
+ /1.0/kb/subscriptions/{subscriptionId}/uncancel:
+ put:
+ tags:
+ - "Subscription"
+ summary: "Un-cancel an entitlement"
+ operationId: "uncancelSubscriptionPlan"
parameters:
- - in: "body"
- name: "body"
+ - name: "subscriptionId"
+ in: "path"
required: true
- schema:
- $ref: "#/definitions/TagDefinition"
+ type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "pluginProperty"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
- "201":
- description: "Tag definition created successfully"
- schema:
- $ref: "#/definitions/TagDefinition"
+ "204":
+ description: "Successful operation"
"400":
- description: "Invalid name or description supplied"
+ description: "Invalid subscription id supplied"
+ "404":
+ description: "Entitlement not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/tagDefinitions/{tagDefinitionId}/auditLogsWithHistory:
- get:
- tags:
- - "TagDefinition"
- summary: "Retrieve tag definition audit logs with history by id"
- description: ""
- operationId: "getTagDefinitionAuditLogsWithHistory"
produces:
- "application/json"
+ /1.0/kb/subscriptions/{subscriptionId}/undoChangePlan:
+ put:
+ tags:
+ - "Subscription"
+ summary: "Undo a pending change plan on an entitlement"
+ operationId: "undoChangeSubscriptionPlan"
parameters:
- - name: "tagDefinitionId"
+ - name: "subscriptionId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "pluginProperty"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ required: false
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ type: "string"
+ required: false
+ - name: "X-Killbill-Comment"
+ in: "header"
+ type: "string"
+ required: false
responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
+ "204":
+ description: "Successful operation"
+ "400":
+ description: "Invalid subscription id supplied"
"404":
- description: "Account not found"
+ description: "Entitlement 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"
+ /1.0/kb/subscriptions/{subscriptionId}/bcd:
+ put:
+ tags:
+ - "Subscription"
+ summary: "Update the BCD associated to a subscription"
+ operationId: "updateSubscriptionBCD"
parameters:
- - name: "offset"
+ - name: "subscriptionId"
+ in: "path"
+ required: true
+ type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/Subscription"
+ - name: "effectiveFromDate"
in: "query"
+ type: "string"
+ format: "date"
required: false
- type: "integer"
- default: 0
- format: "int64"
- - name: "limit"
+ - name: "forceNewBcdWithPastEffectiveDate"
in: "query"
+ type: "boolean"
+ default: false
required: false
- type: "integer"
- default: 100
- format: "int64"
- - name: "audit"
- in: "query"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ type: "string"
required: false
+ - name: "X-Killbill-Comment"
+ in: "header"
type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
+ required: false
responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/Tag"
+ "204":
+ description: "Successful operation"
+ "400":
+ description: "Invalid entitlement supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/tags/search/{searchKey}:
- get:
- tags:
- - "Tag"
- summary: "Search tags"
- description: ""
- operationId: "searchTags"
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/subscriptions/{subscriptionId}/quantity:
+ put:
+ tags:
+ - "Subscription"
+ summary: "Update the quantity associated to a subscription"
+ operationId: "updateSubscriptionQuantity"
parameters:
- - name: "searchKey"
+ - name: "subscriptionId"
in: "path"
required: true
type: "string"
- pattern: ".*"
- - name: "offset"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/Subscription"
+ - name: "effectiveFromDate"
in: "query"
+ type: "string"
+ format: "date"
required: false
- type: "integer"
- default: 0
- format: "int64"
- - name: "limit"
+ - name: "forceNewQuantityWithPastEffectiveDate"
in: "query"
+ type: "boolean"
+ default: false
required: false
- type: "integer"
- default: 100
- format: "int64"
- - name: "audit"
- in: "query"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ type: "string"
required: false
+ - name: "X-Killbill-Comment"
+ in: "header"
type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
+ required: false
responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/Tag"
+ "204":
+ description: "Successful operation"
+ "400":
+ description: "Invalid entitlement supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/tags/{tagId}/auditLogsWithHistory:
- get:
- tags:
- - "Tag"
- summary: "Retrieve tag audit logs with history by id"
- description: ""
- operationId: "getTagAuditLogsWithHistory"
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/tagDefinitions:
+ get:
+ tags:
+ - "TagDefinition"
+ summary: "List tag definitions"
+ operationId: "getTagDefinitions"
parameters:
- - name: "tagId"
- in: "path"
- required: true
+ - 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: "Account not found"
+ $ref: "#/definitions/TagDefinition"
security:
- 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"
+ - "TagDefinition"
+ summary: "Create a tag definition"
+ operationId: "createTagDefinition"
parameters:
- in: "body"
name: "body"
required: true
schema:
- $ref: "#/definitions/Tenant"
- - name: "useGlobalDefault"
- in: "query"
- required: false
- type: "boolean"
- default: false
+ $ref: "#/definitions/TagDefinition"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
- description: "Tenant created successfully"
+ description: "Tag definition created successfully"
schema:
- $ref: "#/definitions/Tenant"
- "409":
- description: "Tenant already exists"
+ $ref: "#/definitions/TagDefinition"
+ "400":
+ description: "Invalid name or description supplied"
security:
- basicAuth: []
- /1.0/kb/tenants/uploadPluginPaymentStateMachineConfig/{pluginName}:
- get:
- tags:
- - "Tenant"
- summary: "Retrieve a per tenant payment state machine for a plugin"
- description: ""
- operationId: "getPluginPaymentStateMachineConfig"
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/tagDefinitions/{tagDefinitionId}:
+ get:
+ tags:
+ - "TagDefinition"
+ summary: "Retrieve a tag definition"
+ operationId: "getTagDefinition"
parameters:
- - name: "pluginName"
+ - name: "tagDefinitionId"
in: "path"
required: true
type: "string"
- pattern: ".*"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "audit"
+ in: "query"
+ required: false
+ type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
responses:
"200":
description: "successful operation"
schema:
- $ref: "#/definitions/TenantKeyValue"
+ $ref: "#/definitions/TagDefinition"
"400":
- description: "Invalid tenantId supplied"
+ description: "Invalid tagDefinitionId supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- post:
- tags:
- - "Tenant"
- summary: "Add a per tenant payment state machine for a plugin"
- description: ""
- operationId: "uploadPluginPaymentStateMachineConfig"
- consumes:
- - "text/plain"
produces:
- "application/json"
+ delete:
+ tags:
+ - "TagDefinition"
+ summary: "Delete a tag definition"
+ operationId: "deleteTagDefinition"
parameters:
- - name: "pluginName"
+ - name: "tagDefinitionId"
in: "path"
required: true
type: "string"
- pattern: ".*"
- - in: "body"
- name: "body"
- required: true
- schema:
- type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
- "201":
- description: "Per tenant state machine uploaded successfully"
- schema:
- $ref: "#/definitions/TenantKeyValue"
+ "204":
+ description: "Successful operation"
"400":
- description: "Invalid tenantId supplied"
+ description: "Invalid tagDefinitionId supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- delete:
+ produces:
+ - "application/json"
+ /1.0/kb/tagDefinitions/{tagDefinitionId}/auditLogsWithHistory:
+ get:
tags:
- - "Tenant"
- summary: "Delete a per tenant payment state machine for a plugin"
- description: ""
- operationId: "deletePluginPaymentStateMachineConfig"
+ - "TagDefinition"
+ summary: "Retrieve tag definition audit logs with history by id"
+ operationId: "getTagDefinitionAuditLogsWithHistory"
parameters:
- - name: "pluginName"
+ - name: "tagDefinitionId"
in: "path"
required: true
type: "string"
- pattern: ".*"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
responses:
- "204":
- description: "Successful operation"
- "400":
- description: "Invalid tenantId supplied"
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/AuditLog"
+ "404":
+ description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/tenants/uploadPerTenantConfig:
- get:
- tags:
- - "Tenant"
- summary: "Retrieve a per tenant configuration (system properties)"
- description: ""
- operationId: "getPerTenantConfiguration"
produces:
- "application/json"
- parameters: []
+ /1.0/kb/tags/{tagId}/auditLogsWithHistory:
+ get:
+ tags:
+ - "Tag"
+ summary: "Retrieve tag audit logs with history by id"
+ operationId: "getTagAuditLogsWithHistory"
+ parameters:
+ - name: "tagId"
+ in: "path"
+ required: true
+ type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
responses:
"200":
description: "successful operation"
schema:
- $ref: "#/definitions/TenantKeyValue"
- "400":
- description: "Invalid tenantId supplied"
+ type: "array"
+ items:
+ $ref: "#/definitions/AuditLog"
+ "404":
+ description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- post:
- tags:
- - "Tenant"
- summary: "Add a per tenant configuration (system properties)"
- description: ""
- operationId: "uploadPerTenantConfiguration"
- consumes:
- - "text/plain"
produces:
- "application/json"
+ /1.0/kb/tags/pagination:
+ get:
+ tags:
+ - "Tag"
+ summary: "List tags"
+ operationId: "getTags"
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"
+ - name: "offset"
+ in: "query"
+ type: "integer"
+ format: "int64"
+ default: 0
required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
+ - name: "limit"
+ in: "query"
+ type: "integer"
+ format: "int64"
+ default: 100
+ required: false
+ - name: "audit"
+ in: "query"
required: false
type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
responses:
- "201":
- description: "Per tenant configuration uploaded successfully"
+ "200":
+ description: "successful operation"
schema:
- $ref: "#/definitions/TenantKeyValue"
- "400":
- description: "Invalid tenantId supplied"
+ type: "array"
+ items:
+ $ref: "#/definitions/Tag"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- delete:
+ produces:
+ - "application/json"
+ /1.0/kb/tags/search/{searchKey}:
+ get:
tags:
- - "Tenant"
- summary: "Delete a per tenant configuration (system properties)"
- description: ""
- operationId: "deletePerTenantConfiguration"
+ - "Tag"
+ summary: "Search tags"
+ operationId: "searchTags"
parameters:
- - name: "X-Killbill-CreatedBy"
- in: "header"
+ - name: "searchKey"
+ in: "path"
required: true
type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
+ pattern: ".*"
+ - name: "offset"
+ in: "query"
+ type: "integer"
+ format: "int64"
+ default: 0
required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
+ - name: "limit"
+ in: "query"
+ type: "integer"
+ format: "int64"
+ default: 100
+ required: false
+ - name: "audit"
+ in: "query"
required: false
type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
responses:
- "204":
- description: "Successful operation"
- "400":
- description: "Invalid tenantId supplied"
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/Tag"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/tenants/uploadPluginConfig/{pluginName}:
+ produces:
+ - "application/json"
+ /1.0/kb/tenants:
get:
tags:
- "Tenant"
- summary: "Retrieve a per tenant configuration for a plugin"
- description: ""
- operationId: "getPluginConfiguration"
- produces:
- - "application/json"
+ summary: "Retrieve a tenant by its API key"
+ operationId: "getTenantByApiKey"
parameters:
- - name: "pluginName"
- in: "path"
- required: true
+ - name: "apiKey"
+ in: "query"
type: "string"
- pattern: ".*"
+ required: false
responses:
"200":
description: "successful operation"
schema:
- $ref: "#/definitions/TenantKeyValue"
- "400":
- description: "Invalid tenantId supplied"
+ $ref: "#/definitions/Tenant"
+ "404":
+ description: "Tenant not found"
security:
- basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
+ produces:
+ - "application/json"
post:
tags:
- "Tenant"
- summary: "Add a per tenant configuration for a plugin"
- description: ""
- operationId: "uploadPluginConfiguration"
+ summary: "Create a tenant"
+ operationId: "createTenant"
+ parameters:
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/Tenant"
+ - name: "useGlobalDefault"
+ in: "query"
+ type: "boolean"
+ default: false
+ required: false
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ type: "string"
+ required: false
+ - name: "X-Killbill-Comment"
+ in: "header"
+ type: "string"
+ required: false
+ responses:
+ "201":
+ description: "Tenant created successfully"
+ schema:
+ $ref: "#/definitions/Tenant"
+ "409":
+ description: "Tenant already exists"
+ security:
+ - basicAuth: []
+ produces:
+ - "application/json"
consumes:
- - "text/plain"
+ - "application/json"
+ /1.0/kb/tenants/uploadPerTenantConfig:
+ get:
+ tags:
+ - "Tenant"
+ summary: "Retrieve a per tenant configuration (system properties)"
+ operationId: "getPerTenantConfiguration"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ $ref: "#/definitions/TenantKeyValue"
+ "400":
+ description: "Invalid tenantId supplied"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
produces:
- "application/json"
+ post:
+ tags:
+ - "Tenant"
+ summary: "Add a per tenant configuration (system properties)"
+ operationId: "uploadPerTenantConfiguration"
parameters:
- - name: "pluginName"
- in: "path"
- required: true
- type: "string"
- pattern: ".*"
- in: "body"
name: "body"
required: true
@@ -10953,15 +10528,15 @@ paths:
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
- description: "Plugin configuration uploaded successfully"
+ description: "Per tenant configuration uploaded successfully"
schema:
$ref: "#/definitions/TenantKeyValue"
"400":
@@ -10970,30 +10545,28 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "text/plain"
delete:
tags:
- "Tenant"
- summary: "Delete a per tenant configuration for a plugin"
- description: ""
- operationId: "deletePluginConfiguration"
+ summary: "Delete a per tenant configuration (system properties)"
+ operationId: "deletePerTenantConfiguration"
parameters:
- - name: "pluginName"
- in: "path"
- required: true
- type: "string"
- pattern: ".*"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"204":
description: "Successful operation"
@@ -11003,16 +10576,18 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/tenants/registerNotificationCallback:
+ /1.0/kb/tenants/uploadPluginConfig/{pluginName}:
get:
tags:
- "Tenant"
- summary: "Retrieve a push notification"
- description: ""
- operationId: "getPushNotificationCallbacks"
- produces:
- - "application/json"
- parameters: []
+ summary: "Retrieve a per tenant configuration for a plugin"
+ operationId: "getPluginConfiguration"
+ parameters:
+ - name: "pluginName"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: ".*"
responses:
"200":
description: "successful operation"
@@ -11024,36 +10599,39 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
post:
tags:
- "Tenant"
- summary: "Create a push notification"
- description: ""
- operationId: "registerPushNotificationCallback"
- consumes:
- - "application/json"
- produces:
- - "application/json"
+ summary: "Add a per tenant configuration for a plugin"
+ operationId: "uploadPluginConfiguration"
parameters:
- - name: "cb"
- in: "query"
- required: false
+ - name: "pluginName"
+ in: "path"
+ required: true
type: "string"
+ pattern: ".*"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ type: "string"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
- description: "Push notification registered successfully"
+ description: "Plugin configuration uploaded successfully"
schema:
$ref: "#/definitions/TenantKeyValue"
"400":
@@ -11062,25 +10640,33 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "text/plain"
delete:
tags:
- "Tenant"
- summary: "Delete a push notification"
- description: ""
- operationId: "deletePushNotificationCallbacks"
+ summary: "Delete a per tenant configuration for a plugin"
+ operationId: "deletePluginConfiguration"
parameters:
+ - name: "pluginName"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: ".*"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"204":
description: "Successful operation"
@@ -11090,17 +10676,14 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/tenants/userKeyValue/{keyName}:
+ /1.0/kb/tenants/uploadPluginPaymentStateMachineConfig/{pluginName}:
get:
tags:
- "Tenant"
- summary: "Retrieve a per tenant user key/value"
- description: ""
- operationId: "getUserKeyValue"
- produces:
- - "application/json"
+ summary: "Retrieve a per tenant payment state machine for a plugin"
+ operationId: "getPluginPaymentStateMachineConfig"
parameters:
- - name: "keyName"
+ - name: "pluginName"
in: "path"
required: true
type: "string"
@@ -11116,18 +10699,15 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
post:
tags:
- "Tenant"
- summary: "Add a per tenant user key/value"
- description: ""
- operationId: "insertUserKeyValue"
- consumes:
- - "text/plain"
- produces:
- - "application/json"
+ summary: "Add a per tenant payment state machine for a plugin"
+ operationId: "uploadPluginPaymentStateMachineConfig"
parameters:
- - name: "keyName"
+ - name: "pluginName"
in: "path"
required: true
type: "string"
@@ -11143,15 +10723,15 @@ paths:
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
- description: "Per tenant config uploaded successfully"
+ description: "Per tenant state machine uploaded successfully"
schema:
$ref: "#/definitions/TenantKeyValue"
"400":
@@ -11160,14 +10740,17 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "text/plain"
delete:
tags:
- "Tenant"
- summary: "Delete a per tenant user key/value"
- description: ""
- operationId: "deleteUserKeyValue"
+ summary: "Delete a per tenant payment state machine for a plugin"
+ operationId: "deletePluginPaymentStateMachineConfig"
parameters:
- - name: "keyName"
+ - name: "pluginName"
in: "path"
required: true
type: "string"
@@ -11178,12 +10761,12 @@ paths:
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"204":
description: "Successful operation"
@@ -11193,220 +10776,257 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/tenants/uploadPerTenantConfig/{keyPrefix}/search:
+ /1.0/kb/tenants/registerNotificationCallback:
get:
tags:
- "Tenant"
- summary: "Retrieve a per tenant key value based on key prefix"
- description: ""
- operationId: "getAllPluginConfiguration"
- produces:
- - "application/json"
- parameters:
- - name: "keyPrefix"
- in: "path"
- required: true
- type: "string"
- pattern: ".*"
+ summary: "Retrieve a push notification"
+ operationId: "getPushNotificationCallbacks"
responses:
"200":
description: "successful operation"
schema:
- type: "array"
- items:
- $ref: "#/definitions/TenantKeyValue"
+ $ref: "#/definitions/TenantKeyValue"
"400":
description: "Invalid tenantId supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/tenants/{tenantId}:
- get:
- tags:
- - "Tenant"
- summary: "Retrieve a tenant by id"
- description: ""
- operationId: "getTenant"
produces:
- "application/json"
+ post:
+ tags:
+ - "Tenant"
+ summary: "Create a push notification"
+ operationId: "registerPushNotificationCallback"
parameters:
- - name: "tenantId"
- in: "path"
+ - name: "cb"
+ in: "query"
+ type: "string"
+ required: false
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ type: "string"
+ required: false
+ - name: "X-Killbill-Comment"
+ in: "header"
+ type: "string"
+ required: false
responses:
- "200":
- description: "successful operation"
+ "201":
+ description: "Push notification registered successfully"
schema:
- $ref: "#/definitions/Tenant"
+ $ref: "#/definitions/TenantKeyValue"
"400":
description: "Invalid tenantId supplied"
- "404":
- description: "Tenant not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/paymentTransactions/{transactionId}/tags:
- get:
- tags:
- - "PaymentTransaction"
- summary: "Retrieve payment transaction tags"
- description: ""
- operationId: "getTransactionTags"
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ delete:
+ tags:
+ - "Tenant"
+ summary: "Delete a push notification"
+ operationId: "deletePushNotificationCallbacks"
parameters:
- - name: "transactionId"
- in: "path"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "includedDeleted"
- in: "query"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ type: "string"
required: false
- type: "boolean"
- default: false
- - name: "audit"
- in: "query"
+ - name: "X-Killbill-Comment"
+ in: "header"
+ type: "string"
required: false
+ responses:
+ "204":
+ description: "Successful operation"
+ "400":
+ description: "Invalid tenantId supplied"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ /1.0/kb/tenants/userKeyValue/{keyName}:
+ get:
+ tags:
+ - "Tenant"
+ summary: "Retrieve a per tenant user key/value"
+ operationId: "getUserKeyValue"
+ parameters:
+ - name: "keyName"
+ in: "path"
+ required: true
type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
+ pattern: ".*"
responses:
"200":
description: "successful operation"
schema:
- type: "array"
- items:
- $ref: "#/definitions/Tag"
+ $ref: "#/definitions/TenantKeyValue"
"400":
- description: "Invalid transaction id supplied"
- "404":
- description: "Invoice not found"
+ description: "Invalid tenantId supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- post:
- tags:
- - "PaymentTransaction"
- summary: "Add tags to payment transaction"
- description: ""
- operationId: "createTransactionTags"
- consumes:
- - "application/json"
produces:
- "application/json"
+ post:
+ tags:
+ - "Tenant"
+ summary: "Add a per tenant user key/value"
+ operationId: "insertUserKeyValue"
parameters:
- - name: "transactionId"
+ - name: "keyName"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
+ pattern: ".*"
- in: "body"
name: "body"
required: true
schema:
- type: "array"
- items:
- type: "string"
- format: "uuid"
+ type: "string"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"201":
- description: "Tag created successfully"
+ description: "Per tenant config uploaded successfully"
schema:
- type: "array"
- items:
- $ref: "#/definitions/Tag"
+ $ref: "#/definitions/TenantKeyValue"
"400":
- description: "Invalid transaction id supplied"
+ description: "Invalid tenantId supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- delete:
- tags:
- - "PaymentTransaction"
- summary: "Remove tags from payment transaction"
- description: ""
- operationId: "deleteTransactionTags"
- consumes:
- - "application/json"
produces:
- "application/json"
+ consumes:
+ - "text/plain"
+ delete:
+ tags:
+ - "Tenant"
+ summary: "Delete a per tenant user key/value"
+ operationId: "deleteUserKeyValue"
parameters:
- - name: "transactionId"
+ - name: "keyName"
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"
+ pattern: ".*"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"204":
description: "Successful operation"
"400":
- description: "Invalid transaction id supplied"
+ description: "Invalid tenantId supplied"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ /1.0/kb/tenants/uploadPerTenantConfig/{keyPrefix}/search:
+ get:
+ tags:
+ - "Tenant"
+ summary: "Retrieve a per tenant key value based on key prefix"
+ operationId: "getAllPluginConfiguration"
+ parameters:
+ - name: "keyPrefix"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: ".*"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/TenantKeyValue"
+ "400":
+ description: "Invalid tenantId supplied"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ produces:
+ - "application/json"
+ /1.0/kb/tenants/{tenantId}:
+ get:
+ tags:
+ - "Tenant"
+ summary: "Retrieve a tenant by id"
+ operationId: "getTenant"
+ parameters:
+ - name: "tenantId"
+ in: "path"
+ required: true
+ type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ $ref: "#/definitions/Tenant"
+ "400":
+ description: "Invalid tenantId supplied"
+ "404":
+ description: "Tenant not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
/1.0/kb/paymentTransactions/{transactionId}/customFields:
get:
tags:
- "PaymentTransaction"
summary: "Retrieve payment transaction custom fields"
- description: ""
operationId: "getTransactionCustomFields"
- produces:
- - "application/json"
parameters:
- name: "transactionId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- name: "audit"
in: "query"
required: false
@@ -11429,23 +11049,20 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- post:
- tags:
- - "PaymentTransaction"
- summary: "Add custom fields to payment transaction"
- description: ""
- operationId: "createTransactionCustomFields"
- consumes:
- - "application/json"
produces:
- "application/json"
+ put:
+ tags:
+ - "PaymentTransaction"
+ summary: "Modify custom fields to payment transaction"
+ operationId: "modifyTransactionCustomFields"
parameters:
- name: "transactionId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
@@ -11459,42 +11076,37 @@ paths:
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
- "201":
- description: "Custom field created successfully"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/CustomField"
+ "204":
+ description: "Successful operation"
"400":
description: "Invalid transaction id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- put:
- tags:
- - "PaymentTransaction"
- summary: "Modify custom fields to payment transaction"
- description: ""
- operationId: "modifyTransactionCustomFields"
- consumes:
- - "application/json"
produces:
- "application/json"
+ consumes:
+ - "application/json"
+ post:
+ tags:
+ - "PaymentTransaction"
+ summary: "Add custom fields to payment transaction"
+ operationId: "createTransactionCustomFields"
parameters:
- name: "transactionId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
@@ -11508,58 +11120,61 @@ paths:
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
- "204":
- description: "Successful operation"
+ "201":
+ description: "Custom field created successfully"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/CustomField"
"400":
description: "Invalid transaction id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
delete:
tags:
- "PaymentTransaction"
summary: "Remove custom fields from payment transaction"
- description: ""
operationId: "deleteTransactionCustomFields"
- consumes:
- - "application/json"
- produces:
- - "application/json"
parameters:
- name: "transactionId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- name: "customField"
in: "query"
- required: false
type: "array"
items:
type: "string"
format: "uuid"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"204":
description: "Successful operation"
@@ -11569,39 +11184,28 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/paymentTransactions/{transactionId}:
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
+ /1.0/kb/paymentTransactions/{transactionId}/tags:
get:
tags:
- "PaymentTransaction"
- summary: "Retrieve a payment by transaction id"
- description: ""
- operationId: "getPaymentByTransactionId"
- produces:
- - "application/json"
+ summary: "Retrieve payment transaction tags"
+ operationId: "getTransactionTags"
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"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - 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
@@ -11615,76 +11219,119 @@ paths:
"200":
description: "successful operation"
schema:
- $ref: "#/definitions/Payment"
+ type: "array"
+ items:
+ $ref: "#/definitions/Tag"
+ "400":
+ description: "Invalid transaction id supplied"
"404":
- description: "Payment not found"
+ description: "Invoice not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
post:
tags:
- "PaymentTransaction"
- summary: "Mark a pending payment transaction as succeeded or failed"
- description: ""
- operationId: "notifyStateChanged"
- consumes:
- - "application/json"
- produces:
- - "application/json"
+ summary: "Add tags to payment transaction"
+ operationId: "createTransactionTags"
parameters:
- name: "transactionId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- in: "body"
name: "body"
required: true
schema:
- $ref: "#/definitions/PaymentTransaction"
- - name: "controlPluginName"
- in: "query"
+ type: "array"
+ items:
+ type: "string"
+ format: "uuid"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ type: "string"
required: false
+ - name: "X-Killbill-Comment"
+ in: "header"
+ type: "string"
+ required: false
+ responses:
+ "201":
+ description: "Tag created successfully"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/Tag"
+ "400":
+ description: "Invalid transaction id supplied"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
+ delete:
+ tags:
+ - "PaymentTransaction"
+ summary: "Remove tags from payment transaction"
+ operationId: "deleteTransactionTags"
+ parameters:
+ - name: "transactionId"
+ in: "path"
+ required: true
+ type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "tagDef"
+ in: "query"
type: "array"
items:
type: "string"
+ format: "uuid"
collectionFormat: "multi"
+ required: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
- "201":
- description: "Successfully notifiy state change"
- schema:
- $ref: "#/definitions/Payment"
+ "204":
+ description: "Successful operation"
"400":
- description: "Invalid paymentId supplied"
- "404":
- description: "Account or Payment not found"
+ description: "Invalid transaction id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
/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"
@@ -11692,21 +11339,21 @@ paths:
type: "string"
- name: "withPluginInfo"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "withAttempts"
in: "query"
- required: false
type: "boolean"
default: false
+ required: false
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
- name: "audit"
in: "query"
required: false
@@ -11727,138 +11374,237 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/paymentTransactions/{transactionId}/auditLogsWithHistory:
+ produces:
+ - "application/json"
+ /1.0/kb/paymentTransactions/{transactionId}:
get:
tags:
- "PaymentTransaction"
- summary: "Retrieve payment transaction audit logs with history by id"
- description: ""
- operationId: "getTransactionAuditLogsWithHistory"
- produces:
- - "application/json"
+ summary: "Retrieve a payment by transaction id"
+ operationId: "getPaymentByTransactionId"
parameters:
- name: "transactionId"
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/usages/{subscriptionId}/{unitType}:
- get:
- tags:
- - "Usage"
- summary: "Retrieve usage for a subscription and unit type"
- description: ""
- operationId: "getUsage"
- produces:
- - "application/json"
- parameters:
- - name: "subscriptionId"
- in: "path"
- required: true
- type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "unitType"
- in: "path"
- required: true
- type: "string"
- - name: "startDate"
+ - name: "withPluginInfo"
in: "query"
+ type: "boolean"
+ default: false
required: false
- type: "string"
- format: "date"
- - name: "endDate"
+ - name: "withAttempts"
in: "query"
+ type: "boolean"
+ default: false
required: false
- type: "string"
- format: "date"
- name: "pluginProperty"
in: "query"
- required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
+ required: false
+ - name: "audit"
+ in: "query"
+ required: false
+ type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
responses:
"200":
description: "successful operation"
schema:
- $ref: "#/definitions/RolledUpUsage"
- "400":
- description: "Missing start date or end date"
+ $ref: "#/definitions/Payment"
+ "404":
+ description: "Payment not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/usages/{subscriptionId}:
- get:
- tags:
- - "Usage"
- summary: "Retrieve usage for a subscription"
- description: ""
- operationId: "getAllUsage"
produces:
- "application/json"
+ post:
+ tags:
+ - "PaymentTransaction"
+ summary: "Mark a pending payment transaction as succeeded or failed"
+ operationId: "notifyStateChanged"
parameters:
- - name: "subscriptionId"
+ - name: "transactionId"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "startDate"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/PaymentTransaction"
+ - name: "controlPluginName"
in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
required: false
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
type: "string"
- format: "date"
- - name: "endDate"
- in: "query"
required: false
+ - name: "X-Killbill-Comment"
+ in: "header"
type: "string"
- format: "date"
- - name: "pluginProperty"
- in: "query"
required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
responses:
- "200":
- description: "successful operation"
+ "201":
+ description: "Successfully notifiy state change"
schema:
- $ref: "#/definitions/RolledUpUsage"
+ $ref: "#/definitions/Payment"
"400":
- description: "Missing start date or end date"
+ description: "Invalid paymentId supplied"
+ "404":
+ description: "Account or Payment not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/usages:
- post:
- tags:
- - "Usage"
- summary: "Record usage for a subscription"
- description: ""
- operationId: "recordUsage"
+ produces:
+ - "application/json"
consumes:
- "application/json"
+ /1.0/kb/paymentTransactions/{transactionId}/auditLogsWithHistory:
+ get:
+ tags:
+ - "PaymentTransaction"
+ summary: "Retrieve payment transaction audit logs with history by id"
+ operationId: "getTransactionAuditLogsWithHistory"
+ parameters:
+ - name: "transactionId"
+ in: "path"
+ required: true
+ type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ 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: []
+ produces:
+ - "application/json"
+ /1.0/kb/usages/{subscriptionId}:
+ get:
+ tags:
+ - "Usage"
+ summary: "Retrieve usage for a subscription"
+ operationId: "getAllUsage"
+ parameters:
+ - name: "subscriptionId"
+ in: "path"
+ required: true
+ type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "startDate"
+ in: "query"
+ type: "string"
+ format: "date"
+ required: false
+ - name: "endDate"
+ in: "query"
+ type: "string"
+ format: "date"
+ required: false
+ - name: "pluginProperty"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ required: false
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ $ref: "#/definitions/RolledUpUsage"
+ "400":
+ description: "Missing start date or end date"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ produces:
+ - "application/json"
+ /1.0/kb/usages/{subscriptionId}/{unitType}:
+ get:
+ tags:
+ - "Usage"
+ summary: "Retrieve usage for a subscription and unit type"
+ operationId: "getUsage"
+ parameters:
+ - name: "subscriptionId"
+ in: "path"
+ required: true
+ type: "string"
+ format: "uuid"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "unitType"
+ in: "path"
+ required: true
+ type: "string"
+ - name: "startDate"
+ in: "query"
+ type: "string"
+ format: "date"
+ required: false
+ - name: "endDate"
+ in: "query"
+ type: "string"
+ format: "date"
+ required: false
+ - name: "pluginProperty"
+ in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ required: false
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ $ref: "#/definitions/RolledUpUsage"
+ "400":
+ description: "Missing start date or end date"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
produces:
- "application/json"
+ /1.0/kb/usages:
+ post:
+ tags:
+ - "Usage"
+ summary: "Record usage for a subscription"
+ operationId: "recordUsage"
parameters:
- in: "body"
name: "body"
@@ -11871,12 +11617,12 @@ paths:
type: "string"
- name: "X-Killbill-Reason"
in: "header"
- required: false
type: "string"
+ required: false
- name: "X-Killbill-Comment"
in: "header"
- required: false
type: "string"
+ required: false
responses:
"200":
description: "Successfully recorded usage data change"
@@ -11886,17 +11632,10 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
-securityDefinitions:
- basicAuth:
- type: "basic"
- Killbill Api Key:
- type: "apiKey"
- name: "X-Killbill-ApiKey"
- in: "header"
- Killbill Api Secret:
- type: "apiKey"
- name: "X-Killbill-ApiSecret"
- in: "header"
+ produces:
+ - "application/json"
+ consumes:
+ - "application/json"
definitions:
AuditLog:
type: "object"
@@ -11941,100 +11680,6 @@ definitions:
type: "string"
history:
$ref: "#/definitions/Entity"
- Entity:
- type: "object"
- properties:
- createdDate:
- type: "string"
- format: "date-time"
- updatedDate:
- type: "string"
- format: "date-time"
- id:
- type: "string"
- format: "uuid"
- 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"
- CustomField:
- type: "object"
- required:
- - "name"
- - "value"
- properties:
- customFieldId:
- type: "string"
- format: "uuid"
- objectId:
- type: "string"
- format: "uuid"
- objectType:
- type: "string"
- enum:
- - "ACCOUNT"
- - "ACCOUNT_EMAIL"
- - "BLOCKING_STATES"
- - "BUNDLE"
- - "CUSTOM_FIELD"
- - "INVOICE"
- - "PAYMENT"
- - "TRANSACTION"
- - "INVOICE_ITEM"
- - "INVOICE_PAYMENT"
- - "SUBSCRIPTION"
- - "SUBSCRIPTION_EVENT"
- - "SERVICE_BROADCAST"
- - "PAYMENT_ATTEMPT"
- - "PAYMENT_METHOD"
- - "TAG"
- - "TAG_DEFINITION"
- - "TENANT"
- - "TENANT_KVS"
- name:
- type: "string"
- value:
- type: "string"
- auditLogs:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
BlockingState:
type: "object"
properties:
@@ -12064,24 +11709,50 @@ definitions:
type: "array"
items:
$ref: "#/definitions/AuditLog"
- Account:
+ Entity:
type: "object"
properties:
- accountId:
+ id:
type: "string"
format: "uuid"
- name:
- type: "string"
- firstNameLength:
- type: "integer"
- format: "int32"
- externalKey:
+ createdDate:
type: "string"
- email:
+ format: "date-time"
+ updatedDate:
type: "string"
- billCycleDayLocal:
- type: "integer"
- format: "int32"
+ format: "date-time"
+ AccountEmail:
+ required:
+ - "email"
+ type: "object"
+ properties:
+ accountId:
+ type: "string"
+ format: "uuid"
+ email:
+ type: "string"
+ auditLogs:
+ type: "array"
+ items:
+ $ref: "#/definitions/AuditLog"
+ Account:
+ type: "object"
+ properties:
+ accountId:
+ type: "string"
+ format: "uuid"
+ name:
+ type: "string"
+ firstNameLength:
+ type: "integer"
+ format: "int32"
+ externalKey:
+ type: "string"
+ email:
+ type: "string"
+ billCycleDayLocal:
+ type: "integer"
+ format: "int32"
currency:
type: "string"
enum:
@@ -12293,286 +11964,454 @@ definitions:
type: "array"
items:
$ref: "#/definitions/AuditLog"
- AccountEmail:
- type: "object"
+ CustomField:
required:
- - "email"
+ - "name"
+ - "value"
+ type: "object"
properties:
- accountId:
+ customFieldId:
type: "string"
format: "uuid"
- email:
+ objectId:
+ type: "string"
+ format: "uuid"
+ objectType:
+ type: "string"
+ enum:
+ - "ACCOUNT"
+ - "ACCOUNT_EMAIL"
+ - "BLOCKING_STATES"
+ - "BUNDLE"
+ - "CUSTOM_FIELD"
+ - "INVOICE"
+ - "PAYMENT"
+ - "TRANSACTION"
+ - "INVOICE_ITEM"
+ - "INVOICE_PAYMENT"
+ - "SUBSCRIPTION"
+ - "SUBSCRIPTION_EVENT"
+ - "SERVICE_BROADCAST"
+ - "PAYMENT_ATTEMPT"
+ - "PAYMENT_METHOD"
+ - "TAG"
+ - "TAG_DEFINITION"
+ - "TENANT"
+ - "TENANT_KVS"
+ name:
+ type: "string"
+ value:
type: "string"
auditLogs:
type: "array"
items:
$ref: "#/definitions/AuditLog"
- InvoicePayment:
+ Tag:
type: "object"
properties:
- targetInvoiceId:
+ tagId:
type: "string"
format: "uuid"
- accountId:
+ 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"
- paymentId:
+ tagDefinitionId:
type: "string"
format: "uuid"
- paymentNumber:
+ tagDefinitionName:
type: "string"
- paymentExternalKey:
+ auditLogs:
+ type: "array"
+ items:
+ $ref: "#/definitions/AuditLog"
+ PaymentMethod:
+ type: "object"
+ properties:
+ paymentMethodId:
type: "string"
- authAmount:
- type: "number"
- capturedAmount:
- type: "number"
- purchasedAmount:
+ format: "uuid"
+ externalKey:
+ type: "string"
+ accountId:
+ type: "string"
+ format: "uuid"
+ isDefault:
+ type: "boolean"
+ pluginName:
+ type: "string"
+ pluginInfo:
+ $ref: "#/definitions/PaymentMethodPluginDetail"
+ auditLogs:
+ type: "array"
+ items:
+ $ref: "#/definitions/AuditLog"
+ PaymentMethodPluginDetail:
+ type: "object"
+ properties:
+ externalPaymentMethodId:
+ type: "string"
+ isDefaultPaymentMethod:
+ type: "boolean"
+ properties:
+ type: "array"
+ items:
+ $ref: "#/definitions/PluginProperty"
+ PluginProperty:
+ type: "object"
+ properties:
+ key:
+ type: "string"
+ value:
+ type: "string"
+ isUpdatable:
+ type: "boolean"
+ BlockPrice:
+ type: "object"
+ properties:
+ unitName:
+ type: "string"
+ size:
type: "number"
- refundedAmount:
+ price:
type: "number"
- creditedAmount:
+ max:
type: "number"
- currency:
+ Bundle:
+ required:
+ - "accountId"
+ type: "object"
+ properties:
+ accountId:
+ type: "string"
+ format: "uuid"
+ bundleId:
+ type: "string"
+ format: "uuid"
+ externalKey:
+ type: "string"
+ subscriptions:
+ type: "array"
+ items:
+ $ref: "#/definitions/Subscription"
+ timeline:
+ $ref: "#/definitions/BundleTimeline"
+ auditLogs:
+ type: "array"
+ items:
+ $ref: "#/definitions/AuditLog"
+ BundleTimeline:
+ type: "object"
+ properties:
+ accountId:
+ type: "string"
+ format: "uuid"
+ bundleId:
+ type: "string"
+ format: "uuid"
+ externalKey:
+ type: "string"
+ events:
+ type: "array"
+ items:
+ $ref: "#/definitions/EventSubscription"
+ auditLogs:
+ type: "array"
+ items:
+ $ref: "#/definitions/AuditLog"
+ EventSubscription:
+ type: "object"
+ properties:
+ eventId:
+ type: "string"
+ format: "uuid"
+ billingPeriod:
type: "string"
enum:
- - "AED"
- - "AFN"
- - "ALL"
- - "AMD"
- - "ANG"
- - "AOA"
- - "ARS"
- - "AUD"
- - "AWG"
- - "AZN"
- - "BAM"
- - "BBD"
- - "BDT"
- - "BGN"
- - "BHD"
- - "BIF"
- - "BMD"
- - "BND"
- - "BOB"
- - "BRL"
- - "BSD"
- - "BTN"
- - "BWP"
- - "BYR"
- - "BZD"
- - "CAD"
- - "CDF"
- - "CHF"
- - "CLP"
- - "CNY"
- - "COP"
- - "CRC"
- - "CUC"
- - "CUP"
- - "CVE"
- - "CZK"
- - "DJF"
- - "DKK"
- - "DOP"
- - "DZD"
- - "EGP"
- - "ERN"
- - "ETB"
- - "EUR"
- - "FJD"
- - "FKP"
- - "GBP"
- - "GEL"
- - "GGP"
- - "GHS"
- - "GIP"
- - "GMD"
- - "GNF"
- - "GTQ"
- - "GYD"
- - "HKD"
- - "HNL"
- - "HRK"
- - "HTG"
- - "HUF"
- - "IDR"
- - "ILS"
- - "IMP"
- - "INR"
- - "IQD"
- - "IRR"
- - "ISK"
- - "JEP"
- - "JMD"
- - "JOD"
- - "JPY"
- - "KES"
- - "KGS"
- - "KHR"
- - "KMF"
- - "KPW"
- - "KRW"
- - "KWD"
- - "KYD"
- - "KZT"
- - "LAK"
- - "LBP"
- - "LKR"
- - "LRD"
- - "LSL"
- - "LTL"
- - "LVL"
- - "LYD"
- - "MAD"
- - "MDL"
- - "MGA"
- - "MKD"
- - "MMK"
- - "MNT"
- - "MOP"
- - "MRO"
- - "MUR"
- - "MVR"
- - "MWK"
- - "MXN"
- - "MYR"
- - "MZN"
- - "NAD"
- - "NGN"
- - "NIO"
- - "NOK"
- - "NPR"
- - "NZD"
- - "OMR"
- - "PAB"
- - "PEN"
- - "PGK"
- - "PHP"
- - "PKR"
- - "PLN"
- - "PYG"
- - "QAR"
- - "RON"
- - "RSD"
- - "RUB"
- - "RWF"
- - "SAR"
- - "SBD"
- - "SCR"
- - "SDG"
- - "SEK"
- - "SGD"
- - "SHP"
- - "SLL"
- - "SOS"
- - "SPL"
- - "SRD"
- - "STD"
- - "SVC"
- - "SYP"
- - "SZL"
- - "THB"
- - "TJS"
- - "TMT"
- - "TND"
- - "TOP"
- - "TRY"
- - "TTD"
- - "TVD"
- - "TWD"
- - "TZS"
- - "UAH"
- - "UGX"
- - "USD"
- - "UYU"
- - "UZS"
- - "VEF"
- - "VND"
- - "VUV"
- - "WST"
- - "XAF"
- - "XCD"
- - "XDR"
- - "XOF"
- - "XPF"
- - "YER"
- - "ZAR"
- - "ZMW"
- - "ZWD"
- - "BTC"
- paymentMethodId:
+ - "DAILY"
+ - "WEEKLY"
+ - "BIWEEKLY"
+ - "THIRTY_DAYS"
+ - "THIRTY_ONE_DAYS"
+ - "SIXTY_DAYS"
+ - "NINETY_DAYS"
+ - "MONTHLY"
+ - "BIMESTRIAL"
+ - "QUARTERLY"
+ - "TRIANNUAL"
+ - "BIANNUAL"
+ - "ANNUAL"
+ - "SESQUIENNIAL"
+ - "BIENNIAL"
+ - "TRIENNIAL"
+ - "NO_BILLING_PERIOD"
+ effectiveDate:
+ type: "string"
+ format: "date-time"
+ catalogEffectiveDate:
+ type: "string"
+ format: "date-time"
+ plan:
+ type: "string"
+ product:
+ type: "string"
+ priceList:
+ type: "string"
+ eventType:
+ type: "string"
+ enum:
+ - "START_ENTITLEMENT"
+ - "START_BILLING"
+ - "PAUSE_ENTITLEMENT"
+ - "PAUSE_BILLING"
+ - "RESUME_ENTITLEMENT"
+ - "RESUME_BILLING"
+ - "PHASE"
+ - "CHANGE"
+ - "EXPIRED"
+ - "BCD_UPDATE"
+ - "QUANTITY_UPDATE"
+ - "STOP_ENTITLEMENT"
+ - "STOP_BILLING"
+ - "SERVICE_STATE_CHANGE"
+ isBlockedBilling:
+ type: "boolean"
+ isBlockedEntitlement:
+ type: "boolean"
+ serviceName:
+ type: "string"
+ serviceStateName:
+ type: "string"
+ phase:
type: "string"
- format: "uuid"
- transactions:
- type: "array"
- items:
- $ref: "#/definitions/PaymentTransaction"
- paymentAttempts:
- type: "array"
- items:
- $ref: "#/definitions/PaymentAttempt"
auditLogs:
type: "array"
items:
$ref: "#/definitions/AuditLog"
- PaymentAttempt:
+ PhasePrice:
+ type: "object"
+ properties:
+ planName:
+ type: "string"
+ phaseName:
+ type: "string"
+ phaseType:
+ type: "string"
+ fixedPrice:
+ type: "number"
+ recurringPrice:
+ type: "number"
+ usagePrices:
+ type: "array"
+ items:
+ $ref: "#/definitions/UsagePrice"
+ Subscription:
+ required:
+ - "billingPeriod"
+ - "planName"
+ - "priceList"
+ - "productName"
type: "object"
properties:
accountId:
type: "string"
format: "uuid"
- paymentMethodId:
+ bundleId:
type: "string"
format: "uuid"
- paymentExternalKey:
+ bundleExternalKey:
type: "string"
- transactionId:
+ subscriptionId:
type: "string"
format: "uuid"
- transactionExternalKey:
- type: "string"
- transactionType:
+ externalKey:
type: "string"
- enum:
- - "AUTHORIZE"
- - "CAPTURE"
- - "CHARGEBACK"
- - "CREDIT"
- - "PURCHASE"
- - "REFUND"
- - "VOID"
- effectiveDate:
+ startDate:
type: "string"
format: "date-time"
- stateName:
+ productName:
type: "string"
- amount:
- type: "number"
- description: "Transaction amount, required except for void operations"
- currency:
+ productCategory:
type: "string"
- description: "Amount currency (account currency unless specified)"
enum:
- - "AED"
- - "AFN"
- - "ALL"
- - "AMD"
- - "ANG"
- - "AOA"
- - "ARS"
- - "AUD"
- - "AWG"
- - "AZN"
- - "BAM"
- - "BBD"
- - "BDT"
- - "BGN"
- - "BHD"
- - "BIF"
- - "BMD"
- - "BND"
- - "BOB"
+ - "BASE"
+ - "ADD_ON"
+ - "STANDALONE"
+ billingPeriod:
+ type: "string"
+ enum:
+ - "DAILY"
+ - "WEEKLY"
+ - "BIWEEKLY"
+ - "THIRTY_DAYS"
+ - "THIRTY_ONE_DAYS"
+ - "SIXTY_DAYS"
+ - "NINETY_DAYS"
+ - "MONTHLY"
+ - "BIMESTRIAL"
+ - "QUARTERLY"
+ - "TRIANNUAL"
+ - "BIANNUAL"
+ - "ANNUAL"
+ - "SESQUIENNIAL"
+ - "BIENNIAL"
+ - "TRIENNIAL"
+ - "NO_BILLING_PERIOD"
+ phaseType:
+ type: "string"
+ enum:
+ - "TRIAL"
+ - "DISCOUNT"
+ - "FIXEDTERM"
+ - "EVERGREEN"
+ priceList:
+ type: "string"
+ planName:
+ type: "string"
+ state:
+ type: "string"
+ enum:
+ - "PENDING"
+ - "ACTIVE"
+ - "BLOCKED"
+ - "CANCELLED"
+ - "EXPIRED"
+ sourceType:
+ type: "string"
+ enum:
+ - "NATIVE"
+ - "MIGRATED"
+ - "TRANSFERRED"
+ cancelledDate:
+ type: "string"
+ format: "date-time"
+ chargedThroughDate:
+ type: "string"
+ format: "date"
+ billingStartDate:
+ type: "string"
+ format: "date-time"
+ billingEndDate:
+ type: "string"
+ format: "date-time"
+ billCycleDayLocal:
+ type: "integer"
+ format: "int32"
+ quantity:
+ type: "integer"
+ format: "int32"
+ events:
+ type: "array"
+ items:
+ $ref: "#/definitions/EventSubscription"
+ priceOverrides:
+ type: "array"
+ items:
+ $ref: "#/definitions/PhasePrice"
+ prices:
+ type: "array"
+ items:
+ $ref: "#/definitions/PhasePrice"
+ auditLogs:
+ type: "array"
+ items:
+ $ref: "#/definitions/AuditLog"
+ TierPrice:
+ type: "object"
+ properties:
+ blockPrices:
+ type: "array"
+ items:
+ $ref: "#/definitions/BlockPrice"
+ UsagePrice:
+ type: "object"
+ properties:
+ usageName:
+ type: "string"
+ usageType:
+ type: "string"
+ enum:
+ - "CAPACITY"
+ - "CONSUMABLE"
+ billingMode:
+ type: "string"
+ enum:
+ - "IN_ADVANCE"
+ - "IN_ARREAR"
+ tierBlockPolicy:
+ type: "string"
+ enum:
+ - "ALL_TIERS"
+ - "TOP_TIER"
+ tierPrices:
+ type: "array"
+ items:
+ $ref: "#/definitions/TierPrice"
+ AccountTimeline:
+ type: "object"
+ properties:
+ account:
+ $ref: "#/definitions/Account"
+ bundles:
+ type: "array"
+ items:
+ $ref: "#/definitions/Bundle"
+ invoices:
+ type: "array"
+ items:
+ $ref: "#/definitions/Invoice"
+ payments:
+ type: "array"
+ items:
+ $ref: "#/definitions/InvoicePayment"
+ Invoice:
+ type: "object"
+ properties:
+ amount:
+ type: "number"
+ currency:
+ type: "string"
+ enum:
+ - "AED"
+ - "AFN"
+ - "ALL"
+ - "AMD"
+ - "ANG"
+ - "AOA"
+ - "ARS"
+ - "AUD"
+ - "AWG"
+ - "AZN"
+ - "BAM"
+ - "BBD"
+ - "BDT"
+ - "BGN"
+ - "BHD"
+ - "BIF"
+ - "BMD"
+ - "BND"
+ - "BOB"
- "BRL"
- "BSD"
- "BTN"
@@ -12719,64 +12558,146 @@ 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:
+ required:
+ - "accountId"
+ - "invoiceItemId"
type: "object"
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"
- amount:
- type: "number"
- description: "Transaction amount, required except for void operations"
- currency:
+ format: "uuid"
+ bundleId:
type: "string"
- description: "Amount currency (account currency unless specified)"
- enum:
- - "AED"
- - "AFN"
- - "ALL"
- - "AMD"
- - "ANG"
- - "AOA"
- - "ARS"
- - "AUD"
- - "AWG"
- - "AZN"
- - "BAM"
- - "BBD"
- - "BDT"
- - "BGN"
- - "BHD"
- - "BIF"
- - "BMD"
+ 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"
+ rate:
+ type: "number"
+ currency:
+ type: "string"
+ enum:
+ - "AED"
+ - "AFN"
+ - "ALL"
+ - "AMD"
+ - "ANG"
+ - "AOA"
+ - "ARS"
+ - "AUD"
+ - "AWG"
+ - "AZN"
+ - "BAM"
+ - "BBD"
+ - "BDT"
+ - "BGN"
+ - "BHD"
+ - "BIF"
+ - "BMD"
- "BND"
- "BOB"
- "BRL"
@@ -12925,12 +12846,48 @@ 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"
+ InvoicePayment:
+ type: "object"
+ properties:
+ targetInvoiceId:
+ type: "string"
+ format: "uuid"
+ accountId:
+ type: "string"
+ format: "uuid"
+ paymentId:
+ type: "string"
+ format: "uuid"
+ paymentNumber:
+ type: "string"
+ paymentExternalKey:
+ type: "string"
+ authAmount:
type: "number"
- processedCurrency:
+ capturedAmount:
+ type: "number"
+ purchasedAmount:
+ type: "number"
+ refundedAmount:
+ type: "number"
+ creditedAmount:
+ type: "number"
+ currency:
type: "string"
enum:
- "AED"
@@ -13097,376 +13054,265 @@ definitions:
- "ZAR"
- "ZMW"
- "ZWD"
- - "BTC"
- status:
- type: "string"
- description: "Transaction status, required for state change notifications"
- enum:
- - "SUCCESS"
- - "UNKNOWN"
- - "PENDING"
- - "PAYMENT_FAILURE"
- - "PLUGIN_FAILURE"
- - "PAYMENT_SYSTEM_OFF"
- gatewayErrorCode:
- type: "string"
- gatewayErrorMsg:
- type: "string"
- firstPaymentReferenceId:
- type: "string"
- secondPaymentReferenceId:
- type: "string"
- properties:
- type: "array"
- items:
- $ref: "#/definitions/PluginProperty"
- auditLogs:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
- PluginProperty:
- type: "object"
- properties:
- key:
- type: "string"
- value:
- type: "string"
- isUpdatable:
- type: "boolean"
- PaymentMethod:
- type: "object"
- properties:
- paymentMethodId:
- type: "string"
- format: "uuid"
- externalKey:
- type: "string"
- accountId:
- type: "string"
- format: "uuid"
- isDefault:
- type: "boolean"
- pluginName:
- type: "string"
- pluginInfo:
- $ref: "#/definitions/PaymentMethodPluginDetail"
- auditLogs:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
- PaymentMethodPluginDetail:
- type: "object"
- properties:
- externalPaymentMethodId:
- type: "string"
- isDefaultPaymentMethod:
- type: "boolean"
- properties:
- type: "array"
- items:
- $ref: "#/definitions/PluginProperty"
- BlockPrice:
- type: "object"
- properties:
- unitName:
- type: "string"
- size:
- type: "number"
- price:
- type: "number"
- max:
- type: "number"
- Bundle:
- type: "object"
- required:
- - "accountId"
- properties:
- accountId:
- type: "string"
- format: "uuid"
- bundleId:
- type: "string"
- format: "uuid"
- externalKey:
- type: "string"
- subscriptions:
- type: "array"
- items:
- $ref: "#/definitions/Subscription"
- timeline:
- $ref: "#/definitions/BundleTimeline"
- auditLogs:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
- BundleTimeline:
- type: "object"
- properties:
- accountId:
- type: "string"
- format: "uuid"
- bundleId:
- type: "string"
- format: "uuid"
- externalKey:
- type: "string"
- events:
- type: "array"
- items:
- $ref: "#/definitions/EventSubscription"
- auditLogs:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
- EventSubscription:
- type: "object"
- properties:
- eventId:
- type: "string"
- format: "uuid"
- billingPeriod:
- type: "string"
- enum:
- - "DAILY"
- - "WEEKLY"
- - "BIWEEKLY"
- - "THIRTY_DAYS"
- - "THIRTY_ONE_DAYS"
- - "SIXTY_DAYS"
- - "NINETY_DAYS"
- - "MONTHLY"
- - "BIMESTRIAL"
- - "QUARTERLY"
- - "TRIANNUAL"
- - "BIANNUAL"
- - "ANNUAL"
- - "SESQUIENNIAL"
- - "BIENNIAL"
- - "TRIENNIAL"
- - "NO_BILLING_PERIOD"
- effectiveDate:
- type: "string"
- format: "date-time"
- catalogEffectiveDate:
- type: "string"
- format: "date-time"
- plan:
- type: "string"
- product:
- type: "string"
- priceList:
- type: "string"
- eventType:
- type: "string"
- enum:
- - "START_ENTITLEMENT"
- - "START_BILLING"
- - "PAUSE_ENTITLEMENT"
- - "PAUSE_BILLING"
- - "RESUME_ENTITLEMENT"
- - "RESUME_BILLING"
- - "PHASE"
- - "CHANGE"
- - "STOP_ENTITLEMENT"
- - "STOP_BILLING"
- - "SERVICE_STATE_CHANGE"
- isBlockedBilling:
- type: "boolean"
- isBlockedEntitlement:
- type: "boolean"
- serviceName:
- type: "string"
- serviceStateName:
- type: "string"
- phase:
- type: "string"
- auditLogs:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
- PhasePrice:
- type: "object"
- properties:
- planName:
- type: "string"
- phaseName:
- type: "string"
- phaseType:
- type: "string"
- fixedPrice:
- type: "number"
- recurringPrice:
- type: "number"
- usagePrices:
- type: "array"
- items:
- $ref: "#/definitions/UsagePrice"
- Subscription:
- type: "object"
- required:
- - "billingPeriod"
- - "planName"
- - "priceList"
- - "productName"
- properties:
- accountId:
- type: "string"
- format: "uuid"
- bundleId:
- type: "string"
- format: "uuid"
- bundleExternalKey:
- type: "string"
- subscriptionId:
- type: "string"
- format: "uuid"
- externalKey:
- type: "string"
- startDate:
- type: "string"
- format: "date-time"
- productName:
- type: "string"
- productCategory:
- type: "string"
- enum:
- - "BASE"
- - "ADD_ON"
- - "STANDALONE"
- billingPeriod:
- type: "string"
- enum:
- - "DAILY"
- - "WEEKLY"
- - "BIWEEKLY"
- - "THIRTY_DAYS"
- - "THIRTY_ONE_DAYS"
- - "SIXTY_DAYS"
- - "NINETY_DAYS"
- - "MONTHLY"
- - "BIMESTRIAL"
- - "QUARTERLY"
- - "TRIANNUAL"
- - "BIANNUAL"
- - "ANNUAL"
- - "SESQUIENNIAL"
- - "BIENNIAL"
- - "TRIENNIAL"
- - "NO_BILLING_PERIOD"
- phaseType:
- type: "string"
- enum:
- - "TRIAL"
- - "DISCOUNT"
- - "FIXEDTERM"
- - "EVERGREEN"
- priceList:
- type: "string"
- planName:
- type: "string"
- state:
- type: "string"
- enum:
- - "PENDING"
- - "ACTIVE"
- - "BLOCKED"
- - "CANCELLED"
- - "EXPIRED"
- sourceType:
- type: "string"
- enum:
- - "NATIVE"
- - "MIGRATED"
- - "TRANSFERRED"
- cancelledDate:
- type: "string"
- format: "date-time"
- chargedThroughDate:
- type: "string"
- format: "date"
- billingStartDate:
- type: "string"
- format: "date-time"
- billingEndDate:
- type: "string"
- format: "date-time"
- billCycleDayLocal:
- type: "integer"
- format: "int32"
- quantity:
- type: "integer"
- format: "int32"
- events:
- type: "array"
- items:
- $ref: "#/definitions/EventSubscription"
- priceOverrides:
+ - "BTC"
+ paymentMethodId:
+ type: "string"
+ format: "uuid"
+ transactions:
type: "array"
items:
- $ref: "#/definitions/PhasePrice"
- prices:
+ $ref: "#/definitions/PaymentTransaction"
+ paymentAttempts:
type: "array"
items:
- $ref: "#/definitions/PhasePrice"
+ $ref: "#/definitions/PaymentAttempt"
auditLogs:
type: "array"
items:
$ref: "#/definitions/AuditLog"
- TierPrice:
- type: "object"
- properties:
- blockPrices:
- type: "array"
- items:
- $ref: "#/definitions/BlockPrice"
- UsagePrice:
+ PaymentAttempt:
type: "object"
properties:
- usageName:
+ accountId:
type: "string"
- usageType:
+ format: "uuid"
+ paymentMethodId:
type: "string"
- enum:
- - "CAPACITY"
- - "CONSUMABLE"
- billingMode:
+ format: "uuid"
+ paymentExternalKey:
+ type: "string"
+ transactionId:
+ type: "string"
+ format: "uuid"
+ transactionExternalKey:
+ type: "string"
+ transactionType:
type: "string"
enum:
- - "IN_ADVANCE"
- - "IN_ARREAR"
- tierBlockPolicy:
+ - "AUTHORIZE"
+ - "CAPTURE"
+ - "CHARGEBACK"
+ - "CREDIT"
+ - "PURCHASE"
+ - "REFUND"
+ - "VOID"
+ effectiveDate:
+ type: "string"
+ format: "date-time"
+ stateName:
+ type: "string"
+ amount:
+ type: "number"
+ description: "Transaction amount, required except for void operations"
+ currency:
type: "string"
+ description: "Amount currency (account currency unless specified)"
enum:
- - "ALL_TIERS"
- - "TOP_TIER"
- tierPrices:
- type: "array"
- items:
- $ref: "#/definitions/TierPrice"
- AccountTimeline:
- type: "object"
- properties:
- account:
- $ref: "#/definitions/Account"
- bundles:
- type: "array"
- items:
- $ref: "#/definitions/Bundle"
- invoices:
+ - "AED"
+ - "AFN"
+ - "ALL"
+ - "AMD"
+ - "ANG"
+ - "AOA"
+ - "ARS"
+ - "AUD"
+ - "AWG"
+ - "AZN"
+ - "BAM"
+ - "BBD"
+ - "BDT"
+ - "BGN"
+ - "BHD"
+ - "BIF"
+ - "BMD"
+ - "BND"
+ - "BOB"
+ - "BRL"
+ - "BSD"
+ - "BTN"
+ - "BWP"
+ - "BYR"
+ - "BZD"
+ - "CAD"
+ - "CDF"
+ - "CHF"
+ - "CLP"
+ - "CNY"
+ - "COP"
+ - "CRC"
+ - "CUC"
+ - "CUP"
+ - "CVE"
+ - "CZK"
+ - "DJF"
+ - "DKK"
+ - "DOP"
+ - "DZD"
+ - "EGP"
+ - "ERN"
+ - "ETB"
+ - "EUR"
+ - "FJD"
+ - "FKP"
+ - "GBP"
+ - "GEL"
+ - "GGP"
+ - "GHS"
+ - "GIP"
+ - "GMD"
+ - "GNF"
+ - "GTQ"
+ - "GYD"
+ - "HKD"
+ - "HNL"
+ - "HRK"
+ - "HTG"
+ - "HUF"
+ - "IDR"
+ - "ILS"
+ - "IMP"
+ - "INR"
+ - "IQD"
+ - "IRR"
+ - "ISK"
+ - "JEP"
+ - "JMD"
+ - "JOD"
+ - "JPY"
+ - "KES"
+ - "KGS"
+ - "KHR"
+ - "KMF"
+ - "KPW"
+ - "KRW"
+ - "KWD"
+ - "KYD"
+ - "KZT"
+ - "LAK"
+ - "LBP"
+ - "LKR"
+ - "LRD"
+ - "LSL"
+ - "LTL"
+ - "LVL"
+ - "LYD"
+ - "MAD"
+ - "MDL"
+ - "MGA"
+ - "MKD"
+ - "MMK"
+ - "MNT"
+ - "MOP"
+ - "MRO"
+ - "MUR"
+ - "MVR"
+ - "MWK"
+ - "MXN"
+ - "MYR"
+ - "MZN"
+ - "NAD"
+ - "NGN"
+ - "NIO"
+ - "NOK"
+ - "NPR"
+ - "NZD"
+ - "OMR"
+ - "PAB"
+ - "PEN"
+ - "PGK"
+ - "PHP"
+ - "PKR"
+ - "PLN"
+ - "PYG"
+ - "QAR"
+ - "RON"
+ - "RSD"
+ - "RUB"
+ - "RWF"
+ - "SAR"
+ - "SBD"
+ - "SCR"
+ - "SDG"
+ - "SEK"
+ - "SGD"
+ - "SHP"
+ - "SLL"
+ - "SOS"
+ - "SPL"
+ - "SRD"
+ - "STD"
+ - "SVC"
+ - "SYP"
+ - "SZL"
+ - "THB"
+ - "TJS"
+ - "TMT"
+ - "TND"
+ - "TOP"
+ - "TRY"
+ - "TTD"
+ - "TVD"
+ - "TWD"
+ - "TZS"
+ - "UAH"
+ - "UGX"
+ - "USD"
+ - "UYU"
+ - "UZS"
+ - "VEF"
+ - "VND"
+ - "VUV"
+ - "WST"
+ - "XAF"
+ - "XCD"
+ - "XDR"
+ - "XOF"
+ - "XPF"
+ - "YER"
+ - "ZAR"
+ - "ZMW"
+ - "ZWD"
+ - "BTC"
+ pluginName:
+ type: "string"
+ pluginProperties:
type: "array"
items:
- $ref: "#/definitions/Invoice"
- payments:
+ $ref: "#/definitions/PluginProperty"
+ auditLogs:
type: "array"
items:
- $ref: "#/definitions/InvoicePayment"
- Invoice:
+ $ref: "#/definitions/AuditLog"
+ PaymentTransaction:
type: "object"
properties:
+ transactionId:
+ type: "string"
+ format: "uuid"
+ transactionExternalKey:
+ type: "string"
+ paymentId:
+ type: "string"
+ description: "Associated payment id, required when notifying state transitions"
+ format: "uuid"
+ paymentExternalKey:
+ type: "string"
+ transactionType:
+ type: "string"
+ enum:
+ - "AUTHORIZE"
+ - "CAPTURE"
+ - "CHARGEBACK"
+ - "CREDIT"
+ - "PURCHASE"
+ - "REFUND"
+ - "VOID"
amount:
type: "number"
+ description: "Transaction amount, required except for void operations"
currency:
type: "string"
+ description: "Amount currency (account currency unless specified)"
enum:
- "AED"
- "AFN"
@@ -13633,127 +13479,12 @@ definitions:
- "ZMW"
- "ZWD"
- "BTC"
- status:
- type: "string"
- enum:
- - "DRAFT"
- - "COMMITTED"
- - "VOID"
- creditAdj:
- type: "number"
- refundAdj:
- type: "number"
- invoiceId:
- type: "string"
- format: "uuid"
- invoiceDate:
- type: "string"
- format: "date"
- targetDate:
- type: "string"
- format: "date"
- invoiceNumber:
- type: "string"
- balance:
- type: "number"
- accountId:
- type: "string"
- format: "uuid"
- bundleKeys:
- type: "string"
- credits:
- type: "array"
- items:
- $ref: "#/definitions/InvoiceItem"
- items:
- type: "array"
- items:
- $ref: "#/definitions/InvoiceItem"
- trackingIds:
- type: "array"
- items:
- type: "string"
- isParentInvoice:
- type: "boolean"
- parentInvoiceId:
- type: "string"
- format: "uuid"
- parentAccountId:
- type: "string"
- format: "uuid"
- auditLogs:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
- InvoiceItem:
- type: "object"
- required:
- - "accountId"
- - "invoiceItemId"
- properties:
- invoiceItemId:
- type: "string"
- format: "uuid"
- invoiceId:
- type: "string"
- format: "uuid"
- linkedInvoiceItemId:
- type: "string"
- format: "uuid"
- accountId:
- type: "string"
- format: "uuid"
- childAccountId:
- type: "string"
- format: "uuid"
- bundleId:
- type: "string"
- format: "uuid"
- subscriptionId:
- type: "string"
- format: "uuid"
- productName:
- type: "string"
- planName:
- type: "string"
- phaseName:
- type: "string"
- usageName:
- type: "string"
- 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:
+ effectiveDate:
type: "string"
- format: "date"
- amount:
- type: "number"
- rate:
+ format: "date-time"
+ processedAmount:
type: "number"
- currency:
+ processedCurrency:
type: "string"
enum:
- "AED"
@@ -13921,17 +13652,28 @@ definitions:
- "ZMW"
- "ZWD"
- "BTC"
- quantity:
- type: "number"
- itemDetails:
+ status:
type: "string"
- catalogEffectiveDate:
+ description: "Transaction status, required for state change notifications"
+ enum:
+ - "SUCCESS"
+ - "UNKNOWN"
+ - "PENDING"
+ - "PAYMENT_FAILURE"
+ - "PLUGIN_FAILURE"
+ - "PAYMENT_SYSTEM_OFF"
+ gatewayErrorCode:
type: "string"
- format: "date-time"
- childItems:
+ gatewayErrorMsg:
+ type: "string"
+ firstPaymentReferenceId:
+ type: "string"
+ secondPaymentReferenceId:
+ type: "string"
+ properties:
type: "array"
items:
- $ref: "#/definitions/InvoiceItem"
+ $ref: "#/definitions/PluginProperty"
auditLogs:
type: "array"
items:
@@ -14959,8 +14701,8 @@ definitions:
type: "string"
paymentId:
type: "string"
- format: "uuid"
description: "Associated payment id, required when notifying state transitions"
+ format: "uuid"
paymentExternalKey:
type: "string"
transactionType:
@@ -15370,6 +15112,9 @@ definitions:
- "RESUME_BILLING"
- "PHASE"
- "CHANGE"
+ - "EXPIRED"
+ - "BCD_UPDATE"
+ - "QUANTITY_UPDATE"
- "STOP_ENTITLEMENT"
- "STOP_BILLING"
- "SERVICE_STATE_CHANGE"
@@ -15432,24 +15177,6 @@ definitions:
$ref: "#/definitions/PhasePrice"
planName:
type: "string"
- NodeCommand:
- type: "object"
- properties:
- isSystemCommandType:
- type: "boolean"
- nodeCommandType:
- type: "string"
- nodeCommandProperties:
- type: "array"
- items:
- $ref: "#/definitions/NodeCommandProperty"
- NodeCommandProperty:
- type: "object"
- properties:
- key:
- type: "string"
- value:
- type: "object"
NodeInfo:
type: "object"
properties:
@@ -15491,8 +15218,8 @@ definitions:
isSelectedForStart:
type: "boolean"
services:
- type: "array"
uniqueItems: true
+ type: "array"
items:
$ref: "#/definitions/PluginServiceInfo"
PluginServiceInfo:
@@ -15502,6 +15229,24 @@ definitions:
type: "string"
registrationName:
type: "string"
+ NodeCommand:
+ type: "object"
+ properties:
+ isSystemCommandType:
+ type: "boolean"
+ nodeCommandType:
+ type: "string"
+ nodeCommandProperties:
+ type: "array"
+ items:
+ $ref: "#/definitions/NodeCommandProperty"
+ NodeCommandProperty:
+ type: "object"
+ properties:
+ key:
+ type: "string"
+ value:
+ type: "object"
Overdue:
type: "object"
properties:
@@ -15607,13 +15352,6 @@ definitions:
type: "array"
items:
$ref: "#/definitions/AuditLog"
- HostedPaymentPageFields:
- type: "object"
- properties:
- formFields:
- type: "array"
- items:
- $ref: "#/definitions/PluginProperty"
ComboHostedPaymentPage:
type: "object"
properties:
@@ -15631,6 +15369,13 @@ definitions:
type: "array"
items:
$ref: "#/definitions/AuditLog"
+ HostedPaymentPageFields:
+ type: "object"
+ properties:
+ formFields:
+ type: "array"
+ items:
+ $ref: "#/definitions/PluginProperty"
ComboPaymentTransaction:
type: "object"
properties:
@@ -15652,12 +15397,24 @@ definitions:
type: "array"
items:
$ref: "#/definitions/AuditLog"
- UserRoles:
+ RoleDefinition:
+ required:
+ - "permissions"
+ - "role"
type: "object"
+ properties:
+ role:
+ type: "string"
+ permissions:
+ type: "array"
+ items:
+ type: "string"
+ UserRoles:
required:
- "password"
- "roles"
- "username"
+ type: "object"
properties:
username:
type: "string"
@@ -15667,18 +15424,6 @@ definitions:
type: "array"
items:
type: "string"
- RoleDefinition:
- type: "object"
- required:
- - "permissions"
- - "role"
- properties:
- role:
- type: "string"
- permissions:
- type: "array"
- items:
- type: "string"
Session:
type: "object"
properties:
@@ -15707,19 +15452,19 @@ definitions:
session:
$ref: "#/definitions/Session"
BulkSubscriptionsBundle:
- type: "object"
required:
- "baseEntitlementAndAddOns"
+ type: "object"
properties:
baseEntitlementAndAddOns:
type: "array"
items:
$ref: "#/definitions/Subscription"
TagDefinition:
- type: "object"
required:
- "description"
- "name"
+ type: "object"
properties:
id:
type: "string"
@@ -15731,8 +15476,8 @@ definitions:
description:
type: "string"
applicableObjectTypes:
- type: "array"
uniqueItems: true
+ type: "array"
items:
type: "string"
enum:
@@ -15760,10 +15505,10 @@ definitions:
items:
$ref: "#/definitions/AuditLog"
Tenant:
- type: "object"
required:
- "apiKey"
- "apiSecret"
+ type: "object"
properties:
tenantId:
type: "string"
@@ -15815,10 +15560,10 @@ definitions:
items:
$ref: "#/definitions/RolledUpUnit"
SubscriptionUsageRecord:
- type: "object"
required:
- "subscriptionId"
- "unitUsageRecords"
+ type: "object"
properties:
subscriptionId:
type: "string"
diff --git a/pom.xml b/pom.xml
index ee75f5e..998b900 100644
--- a/pom.xml
+++ b/pom.xml
@@ -22,7 +22,7 @@
org.kill-bill.billing
killbill-oss-parent
- 0.147.16
+ 0.147.19
killbill-client-java
1.5.3-SNAPSHOT
diff --git a/src/main/java/org/killbill/billing/client/api/gen/SecurityApi.java b/src/main/java/org/killbill/billing/client/api/gen/SecurityApi.java
index 1c425db..bb0fffb 100644
--- a/src/main/java/org/killbill/billing/client/api/gen/SecurityApi.java
+++ b/src/main/java/org/killbill/billing/client/api/gen/SecurityApi.java
@@ -25,20 +25,15 @@
import org.killbill.billing.client.model.gen.RoleDefinition;
import org.killbill.billing.client.model.gen.Subject;
import org.killbill.billing.client.model.gen.UserRoles;
+import org.killbill.billing.client.model.RoleDefinitions;
import org.killbill.billing.client.model.Strings;
-import java.util.List;
-import java.time.format.DateTimeFormatter;
-
-import org.killbill.billing.client.Converter;
import org.killbill.billing.client.KillBillClientException;
import org.killbill.billing.client.KillBillHttpClient;
import org.killbill.billing.client.RequestOptions;
import org.killbill.billing.client.RequestOptions.RequestOptionsBuilder;
import org.killbill.billing.client.util.Preconditions;
-import org.killbill.billing.client.util.Multimap;
-import org.killbill.billing.client.util.TreeMapSetMultimap;
/**
* DO NOT EDIT !!!
@@ -90,6 +85,18 @@ public UserRoles addUserRoles(final UserRoles body, final RequestOptions inputOp
return httpClient.doPost(uri, body, UserRoles.class, requestOptions);
}
+ public RoleDefinitions getAvailableRoles(final RequestOptions inputOptions) throws KillBillClientException {
+
+ final String uri = "/1.0/kb/security/roles";
+
+
+ final RequestOptionsBuilder inputOptionsBuilder = inputOptions.extend();
+ inputOptionsBuilder.withHeader(KillBillHttpClient.HTTP_HEADER_ACCEPT, "application/json");
+ final RequestOptions requestOptions = inputOptionsBuilder.build();
+
+ return httpClient.doGet(uri, RoleDefinitions.class, requestOptions);
+ }
+
public Strings getCurrentUserPermissions(final RequestOptions inputOptions) throws KillBillClientException {
final String uri = "/1.0/kb/security/permissions";
diff --git a/src/main/java/org/killbill/billing/client/model/RoleDefinitions.java b/src/main/java/org/killbill/billing/client/model/RoleDefinitions.java
new file mode 100644
index 0000000..0e01a0a
--- /dev/null
+++ b/src/main/java/org/killbill/billing/client/model/RoleDefinitions.java
@@ -0,0 +1,25 @@
+/*
+ * Copyright 2020-2026 Equinix, Inc
+ * Copyright 2014-2026 The Billing Project, LLC
+ *
+ * The Billing Project licenses this file to you under the Apache License, version 2.0
+ * (the "License"); you may not use this file except in compliance with the
+ * License. You may obtain a copy of the License at:
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.killbill.billing.client.model;
+
+import java.util.ArrayList;
+
+import org.killbill.billing.client.model.gen.RoleDefinition;
+
+public class RoleDefinitions extends ArrayList {
+}