diff --git a/.swagger-codegen/KB_VERSION b/.swagger-codegen/KB_VERSION
index b9f9e3c..325720e 100644
--- a/.swagger-codegen/KB_VERSION
+++ b/.swagger-codegen/KB_VERSION
@@ -1,4 +1,4 @@
swaggerVersion=2.4.1
-kbVersion=0.24.17-SNAPSHOT
+kbVersion=0.24.19-SNAPSHOT
kbApiVersion=0.54.0
kbPluginApiVersion=0.27.3
diff --git a/.swagger-codegen/kbswagger.yaml b/.swagger-codegen/kbswagger.yaml
index 3e6ea09..84939dc 100644
--- a/.swagger-codegen/kbswagger.yaml
+++ b/.swagger-codegen/kbswagger.yaml
@@ -2,7 +2,7 @@
swagger: "2.0"
info:
description: "Kill Bill is an open-source billing and payments platform"
- version: "0.24.17-SNAPSHOT"
+ version: "0.24.19-SNAPSHOT"
title: "Kill Bill"
contact:
name: "killbilling-users@googlegroups.com"
@@ -34,13 +34,13 @@ tags:
- name: "PaymentTransaction"
- name: "Usage"
paths:
- /1.0/kb/accounts/{accountId}/children:
+ /1.0/kb/accounts/{accountId}/tags:
get:
tags:
- "Account"
- summary: "List children accounts"
+ summary: "Retrieve account tags"
description: ""
- operationId: "getChildrenAccounts"
+ operationId: "getAccountTags"
produces:
- "application/json"
parameters:
@@ -50,12 +50,7 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "accountWithBalance"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "accountWithBalanceAndCBA"
+ - name: "includedDeleted"
in: "query"
required: false
type: "boolean"
@@ -75,22 +70,23 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/Account"
+ $ref: "#/definitions/Tag"
"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/{accountId}/emails:
- get:
+ post:
tags:
- "Account"
- summary: "Retrieve an account emails"
+ summary: "Add tags to account"
description: ""
- operationId: "getEmails"
+ operationId: "createAccountTags"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
@@ -100,25 +96,45 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ type: "array"
+ items:
+ type: "string"
+ format: "uuid"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ required: false
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
+ required: false
+ type: "string"
responses:
- "200":
- description: "successful operation"
+ "201":
+ description: "Tag created successfully"
schema:
type: "array"
items:
- $ref: "#/definitions/AccountEmail"
+ $ref: "#/definitions/Tag"
"400":
description: "Invalid account id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- post:
+ delete:
tags:
- "Account"
- summary: "Add account email"
+ summary: "Remove tags from account"
description: ""
- operationId: "addEmail"
+ operationId: "deleteAccountTags"
consumes:
- "application/json"
produces:
@@ -130,11 +146,14 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- $ref: "#/definitions/AccountEmail"
+ - name: "tagDef"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ format: "uuid"
+ collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -148,44 +167,31 @@ paths:
required: false
type: "string"
responses:
- "201":
- description: "Email created successfully"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/AccountEmail"
+ "204":
+ description: "Successful operation"
"400":
- description: "Invalid account id supplied"
- "404":
- description: "Account not found"
+ 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:
+ /1.0/kb/accounts/{accountId}/customFields:
get:
tags:
- "Account"
- summary: "Retrieve an account by external key"
+ summary: "Retrieve account custom fields"
description: ""
- operationId: "getAccountByKey"
+ operationId: "getAccountCustomFields"
produces:
- "application/json"
parameters:
- - name: "externalKey"
- in: "query"
+ - name: "accountId"
+ in: "path"
required: true
type: "string"
- - name: "accountWithBalance"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "accountWithBalanceAndCBA"
- in: "query"
- required: false
- type: "boolean"
- default: false
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
- name: "audit"
in: "query"
required: false
@@ -199,9 +205,11 @@ paths:
"200":
description: "successful operation"
schema:
- $ref: "#/definitions/Account"
- "404":
- description: "Account not found"
+ type: "array"
+ items:
+ $ref: "#/definitions/CustomField"
+ "400":
+ description: "Invalid account id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -209,19 +217,27 @@ paths:
post:
tags:
- "Account"
- summary: "Create account"
+ summary: "Add custom fields to account"
description: ""
- operationId: "createAccount"
+ operationId: "createAccountCustomFields"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
+ - name: "accountId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
- in: "body"
name: "body"
required: true
schema:
- $ref: "#/definitions/Account"
+ type: "array"
+ items:
+ $ref: "#/definitions/CustomField"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -236,59 +252,13 @@ paths:
type: "string"
responses:
"201":
- description: "Account created successfully"
- schema:
- $ref: "#/definitions/Account"
- "400":
- description: "Invalid account data supplied"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}:
- get:
- tags:
- - "Account"
- summary: "Retrieve an account by id"
- description: ""
- operationId: "getAccount"
- produces:
- - "application/json"
- parameters:
- - name: "accountId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "accountWithBalance"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "accountWithBalanceAndCBA"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "audit"
- in: "query"
- required: false
- type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
- responses:
- "200":
- description: "successful operation"
+ description: "Custom field created successfully"
schema:
- $ref: "#/definitions/Account"
+ type: "array"
+ items:
+ $ref: "#/definitions/CustomField"
"400":
description: "Invalid account id supplied"
- "404":
- description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -296,9 +266,9 @@ paths:
put:
tags:
- "Account"
- summary: "Update account"
+ summary: "Modify custom fields to account"
description: ""
- operationId: "updateAccount"
+ operationId: "modifyAccountCustomFields"
consumes:
- "application/json"
produces:
@@ -314,12 +284,9 @@ paths:
name: "body"
required: true
schema:
- $ref: "#/definitions/Account"
- - name: "treatNullAsReset"
- in: "query"
- required: false
- type: "boolean"
- default: false
+ type: "array"
+ items:
+ $ref: "#/definitions/CustomField"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -336,7 +303,7 @@ paths:
"204":
description: "Successful operation"
"400":
- description: "Invalid account data supplied"
+ description: "Invalid account id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -344,9 +311,11 @@ paths:
delete:
tags:
- "Account"
- summary: "Close account"
+ summary: "Remove custom fields from account"
description: ""
- operationId: "closeAccount"
+ operationId: "deleteAccountCustomFields"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
@@ -356,26 +325,14 @@ paths:
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"
+ - name: "customField"
in: "query"
required: false
- type: "boolean"
- default: true
+ type: "array"
+ items:
+ type: "string"
+ format: "uuid"
+ collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -397,43 +354,40 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/search/{searchKey}:
+ /1.0/kb/accounts/{accountId}/block:
get:
tags:
- "Account"
- summary: "Search accounts"
+ summary: "Retrieve blocking states for account"
description: ""
- operationId: "searchAccounts"
+ operationId: "getBlockingStates"
produces:
- "application/json"
parameters:
- - name: "searchKey"
+ - name: "accountId"
in: "path"
required: true
type: "string"
- pattern: ".*"
- - name: "offset"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - name: "blockingStateTypes"
in: "query"
required: false
- type: "integer"
- default: 0
- format: "int64"
- - name: "limit"
+ type: "array"
+ items:
+ type: "string"
+ enum:
+ - "SUBSCRIPTION"
+ - "SUBSCRIPTION_BUNDLE"
+ - "ACCOUNT"
+ collectionFormat: "multi"
+ - name: "blockingStateSvcs"
in: "query"
required: false
- type: "integer"
- default: 100
- format: "int64"
- - name: "accountWithBalance"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "accountWithBalanceAndCBA"
- in: "query"
- required: false
- type: "boolean"
- default: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
- name: "audit"
in: "query"
required: false
@@ -449,33 +403,115 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/Account"
+ $ref: "#/definitions/BlockingState"
+ "400":
+ description: "Invalid account id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/pagination:
- get:
+ post:
tags:
- "Account"
- summary: "List accounts"
+ summary: "Block an account"
description: ""
- operationId: "getAccounts"
- produces:
+ operationId: "addAccountBlockingState"
+ consumes:
- "application/json"
parameters:
- - name: "offset"
+ - name: "accountId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/BlockingState"
+ - name: "requestedDate"
in: "query"
required: false
- type: "integer"
- default: 0
- format: "int64"
- - name: "limit"
+ type: "string"
+ format: "date"
+ - name: "pluginProperty"
in: "query"
required: false
- type: "integer"
- default: 100
- format: "int64"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ required: false
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
+ required: false
+ type: "string"
+ responses:
+ "201":
+ description: "Blocking state created successfully"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/BlockingState"
+ "400":
+ description: "Invalid 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"
+ required: true
+ type: "string"
- name: "accountWithBalance"
in: "query"
required: false
@@ -499,33 +535,29 @@ paths:
"200":
description: "successful operation"
schema:
- type: "array"
- items:
- $ref: "#/definitions/Account"
+ $ref: "#/definitions/Account"
+ "404":
+ description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/emails/{email}:
- delete:
+ post:
tags:
- "Account"
- summary: "Delete email from account"
+ summary: "Create account"
description: ""
- operationId: "removeEmail"
+ operationId: "createAccount"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
- - name: "accountId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "email"
- in: "path"
+ - in: "body"
+ name: "body"
required: true
- type: "string"
+ schema:
+ $ref: "#/definitions/Account"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -539,31 +571,49 @@ paths:
required: false
type: "string"
responses:
- "204":
- description: "Successful operation"
+ "201":
+ description: "Account created successfully"
+ schema:
+ $ref: "#/definitions/Account"
"400":
- description: "Invalid account id supplied"
+ description: "Invalid account data supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/tags:
+ /1.0/kb/accounts/search/{searchKey}:
get:
tags:
- "Account"
- summary: "Retrieve account tags"
+ summary: "Search accounts"
description: ""
- operationId: "getAccountTags"
+ operationId: "searchAccounts"
produces:
- "application/json"
parameters:
- - name: "accountId"
+ - name: "searchKey"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "includedDeleted"
+ 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"
@@ -583,11 +633,36 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/Tag"
+ $ref: "#/definitions/Account"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ /1.0/kb/accounts/{accountId}/emails:
+ get:
+ tags:
+ - "Account"
+ summary: "Retrieve an account emails"
+ description: ""
+ operationId: "getEmails"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "accountId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/AccountEmail"
"400":
description: "Invalid account id supplied"
- "404":
- description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -595,9 +670,9 @@ paths:
post:
tags:
- "Account"
- summary: "Add tags to account"
+ summary: "Add account email"
description: ""
- operationId: "createAccountTags"
+ operationId: "addEmail"
consumes:
- "application/json"
produces:
@@ -613,10 +688,7 @@ paths:
name: "body"
required: true
schema:
- type: "array"
- items:
- type: "string"
- format: "uuid"
+ $ref: "#/definitions/AccountEmail"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -631,25 +703,26 @@ paths:
type: "string"
responses:
"201":
- description: "Tag created successfully"
+ description: "Email created successfully"
schema:
type: "array"
items:
- $ref: "#/definitions/Tag"
+ $ref: "#/definitions/AccountEmail"
"400":
description: "Invalid account id supplied"
+ "404":
+ description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ /1.0/kb/accounts/{accountId}/emails/{email}:
delete:
tags:
- "Account"
- summary: "Remove tags from account"
+ summary: "Delete email from account"
description: ""
- operationId: "deleteAccountTags"
- consumes:
- - "application/json"
+ operationId: "removeEmail"
produces:
- "application/json"
parameters:
@@ -659,17 +732,13 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "tagDef"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- format: "uuid"
- collectionFormat: "multi"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
+ - name: "email"
+ in: "path"
+ required: true
+ type: "string"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
type: "string"
- name: "X-Killbill-Reason"
in: "header"
@@ -683,36 +752,43 @@ paths:
"204":
description: "Successful operation"
"400":
- description: "Invalid account id supplied or account does not have a default\
- \ payment method (AUTO_PAY_OFF tag only)"
+ description: "Invalid account id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/bundles:
+ /1.0/kb/accounts/pagination:
get:
tags:
- "Account"
- summary: "Retrieve bundles for account"
+ summary: "List accounts"
description: ""
- operationId: "getAccountBundles"
+ operationId: "getAccounts"
produces:
- "application/json"
parameters:
- - name: "accountId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "externalKey"
+ - name: "offset"
in: "query"
required: false
- type: "string"
- - name: "bundlesFilter"
+ type: "integer"
+ default: 0
+ format: "int64"
+ - name: "limit"
in: "query"
required: false
- type: "string"
+ type: "integer"
+ default: 100
+ format: "int64"
+ - name: "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
@@ -728,22 +804,18 @@ 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}/timeline:
+ /1.0/kb/accounts/{accountId}:
get:
tags:
- "Account"
- summary: "Retrieve account timeline"
+ summary: "Retrieve an account by id"
description: ""
- operationId: "getAccountTimeline"
+ operationId: "getAccount"
produces:
- "application/json"
parameters:
@@ -753,7 +825,12 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "parallel"
+ - name: "accountWithBalance"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "accountWithBalanceAndCBA"
in: "query"
required: false
type: "boolean"
@@ -771,7 +848,7 @@ paths:
"200":
description: "successful operation"
schema:
- $ref: "#/definitions/AccountTimeline"
+ $ref: "#/definitions/Account"
"400":
description: "Invalid account id supplied"
"404":
@@ -780,13 +857,14 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/allCustomFields:
- get:
+ put:
tags:
- "Account"
- summary: "Retrieve account customFields"
+ summary: "Update account"
description: ""
- operationId: "getAllCustomFields"
+ operationId: "updateAccount"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
@@ -796,61 +874,100 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "objectType"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/Account"
+ - name: "treatNullAsReset"
in: "query"
required: false
+ type: "boolean"
+ default: false
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
type: "string"
- 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"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ required: false
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
+ required: false
+ type: "string"
+ responses:
+ "204":
+ description: "Successful operation"
+ "400":
+ description: "Invalid account data supplied"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ delete:
+ tags:
+ - "Account"
+ summary: "Close account"
+ description: ""
+ operationId: "closeAccount"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "accountId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - name: "cancelAllSubscriptions"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "writeOffUnpaidInvoices"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "itemAdjustUnpaidInvoices"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "removeFutureNotifications"
in: "query"
required: false
+ type: "boolean"
+ default: true
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ required: false
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
+ required: false
type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/CustomField"
+ "204":
+ description: "Successful operation"
"400":
description: "Invalid account id supplied"
- "404":
- description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/allTags:
+ /1.0/kb/accounts/{accountId}/children:
get:
tags:
- "Account"
- summary: "Retrieve account tags"
+ summary: "List children accounts"
description: ""
- operationId: "getAllTags"
+ operationId: "getChildrenAccounts"
produces:
- "application/json"
parameters:
@@ -860,31 +977,12 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "objectType"
+ - name: "accountWithBalance"
in: "query"
required: false
- type: "string"
- enum:
- - "ACCOUNT"
- - "ACCOUNT_EMAIL"
- - "BLOCKING_STATES"
- - "BUNDLE"
- - "CUSTOM_FIELD"
- - "INVOICE"
- - "PAYMENT"
- - "TRANSACTION"
- - "INVOICE_ITEM"
- - "INVOICE_PAYMENT"
- - "SUBSCRIPTION"
- - "SUBSCRIPTION_EVENT"
- - "SERVICE_BROADCAST"
- - "PAYMENT_ATTEMPT"
- - "PAYMENT_METHOD"
- - "TAG"
- - "TAG_DEFINITION"
- - "TENANT"
- - "TENANT_KVS"
- - name: "includedDeleted"
+ type: "boolean"
+ default: false
+ - name: "accountWithBalanceAndCBA"
in: "query"
required: false
type: "boolean"
@@ -904,38 +1002,50 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/Tag"
+ $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}/overdue:
- get:
+ /1.0/kb/accounts/{childAccountId}/transferCredit:
+ put:
tags:
- "Account"
- summary: "Retrieve overdue state for account"
+ summary: "Move a given child credit to the parent level"
description: ""
- operationId: "getOverdueAccount"
+ operationId: "transferChildCreditToParent"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
- - name: "accountId"
+ - name: "childAccountId"
in: "path"
required: true
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ required: false
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
+ required: false
+ type: "string"
responses:
- "200":
- description: "successful operation"
- schema:
- $ref: "#/definitions/OverdueState"
+ "204":
+ description: "Successful operation"
"400":
- description: "Invalid account id supplied"
+ description: "Account does not have credit"
"404":
description: "Account not found"
security:
@@ -1069,13 +1179,15 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/payments:
- get:
+ /1.0/kb/accounts/{accountId}/paymentMethods/{paymentMethodId}/setDefault:
+ put:
tags:
- "Account"
- summary: "Retrieve account payments"
+ summary: "Set the default payment method"
description: ""
- operationId: "getPaymentsForAccount"
+ operationId: "setDefaultPaymentMethod"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
@@ -1085,12 +1197,13 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "withAttempts"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "withPluginInfo"
+ - name: "paymentMethodId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - name: "payAllUnpaidInvoices"
in: "query"
required: false
type: "boolean"
@@ -1102,36 +1215,36 @@ paths:
items:
type: "string"
collectionFormat: "multi"
- - name: "audit"
- in: "query"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ required: false
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
required: false
type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/Payment"
+ "204":
+ description: "Successful operation"
"400":
- description: "Invalid account id supplied"
+ description: "Invalid account id or payment method id supplied"
+ "404":
+ description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- post:
+ /1.0/kb/accounts/{accountId}/paymentMethods/refresh:
+ put:
tags:
- "Account"
- summary: "Trigger a payment (authorization, purchase or credit)"
+ summary: "Refresh account payment methods"
description: ""
- operationId: "processPayment"
- consumes:
- - "application/json"
+ operationId: "refreshPaymentMethods"
produces:
- "application/json"
parameters:
@@ -1141,23 +1254,10 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- $ref: "#/definitions/PaymentTransaction"
- - name: "paymentMethodId"
+ - name: "pluginName"
in: "query"
required: false
type: "string"
- format: "uuid"
- - name: "controlPluginName"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- name: "pluginProperty"
in: "query"
required: false
@@ -1178,24 +1278,12 @@ paths:
required: false
type: "string"
responses:
- "201":
- description: "Payment transaction created successfully"
- schema:
- $ref: "#/definitions/Payment"
+ "204":
+ description: "Successful operation"
"400":
description: "Invalid account id supplied"
"404":
description: "Account not found"
- "402":
- description: "Transaction declined by gateway"
- "422":
- description: "Payment is aborted by a control plugin"
- "502":
- description: "Failed to submit payment transaction"
- "503":
- description: "Payment in unknown status, failed to receive gateway response"
- "504":
- description: "Payment operation timeout"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -1328,13 +1416,13 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/customFields:
+ /1.0/kb/accounts/{accountId}/auditLogsWithHistory:
get:
tags:
- "Account"
- summary: "Retrieve account custom fields"
+ summary: "Retrieve account audit logs with history by account id"
description: ""
- operationId: "getAccountCustomFields"
+ operationId: "getAccountAuditLogsWithHistory"
produces:
- "application/json"
parameters:
@@ -1344,6 +1432,43 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/AuditLog"
+ "404":
+ description: "Account not found"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ /1.0/kb/accounts/{accountId}/bundles:
+ get:
+ tags:
+ - "Account"
+ summary: "Retrieve bundles for account"
+ description: ""
+ operationId: "getAccountBundles"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "accountId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - name: "externalKey"
+ in: "query"
+ required: false
+ type: "string"
+ - name: "bundlesFilter"
+ in: "query"
+ required: false
+ type: "string"
- name: "audit"
in: "query"
required: false
@@ -1359,21 +1484,22 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/CustomField"
+ $ref: "#/definitions/Bundle"
"400":
description: "Invalid account id supplied"
+ "404":
+ description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- post:
+ /1.0/kb/accounts/{accountId}/bundles/pagination:
+ get:
tags:
- "Account"
- summary: "Add custom fields to account"
+ summary: "Retrieve paginated bundles for account"
description: ""
- operationId: "createAccountCustomFields"
- consumes:
- - "application/json"
+ operationId: "getAccountBundlesPaginated"
produces:
- "application/json"
parameters:
@@ -1383,46 +1509,49 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- type: "array"
- items:
- $ref: "#/definitions/CustomField"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
+ - name: "offset"
+ in: "query"
required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
+ type: "integer"
+ default: 0
+ format: "int64"
+ - name: "limit"
+ in: "query"
+ required: false
+ type: "integer"
+ default: 100
+ format: "int64"
+ - name: "audit"
+ in: "query"
required: false
type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
responses:
- "201":
- description: "Custom field created successfully"
+ "200":
+ description: "successful operation"
schema:
type: "array"
items:
- $ref: "#/definitions/CustomField"
+ $ref: "#/definitions/Bundle"
"400":
description: "Invalid account id supplied"
+ "404":
+ description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- put:
+ /1.0/kb/accounts/{accountId}/emails/{accountEmailId}/auditLogsWithHistory:
+ get:
tags:
- "Account"
- summary: "Modify custom fields to account"
+ summary: "Retrieve account email audit logs with history by id"
description: ""
- operationId: "modifyAccountCustomFields"
- consumes:
- - "application/json"
+ operationId: "getAccountEmailAuditLogsWithHistory"
produces:
- "application/json"
parameters:
@@ -1432,42 +1561,32 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- type: "array"
- items:
- $ref: "#/definitions/CustomField"
- - name: "X-Killbill-CreatedBy"
- in: "header"
+ - name: "accountEmailId"
+ in: "path"
required: true
type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
responses:
- "204":
- description: "Successful operation"
- "400":
- description: "Invalid account id supplied"
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/AuditLog"
+ "404":
+ description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- delete:
+ /1.0/kb/accounts/{accountId}/timeline:
+ get:
tags:
- "Account"
- summary: "Remove custom fields from account"
+ summary: "Retrieve account timeline"
description: ""
- operationId: "deleteAccountCustomFields"
- consumes:
- - "application/json"
+ operationId: "getAccountTimeline"
produces:
- "application/json"
parameters:
@@ -1477,120 +1596,104 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "customField"
+ - name: "parallel"
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"
+ type: "boolean"
+ default: false
+ - name: "audit"
+ in: "query"
required: false
type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
responses:
- "204":
- description: "Successful operation"
+ "200":
+ description: "successful operation"
+ schema:
+ $ref: "#/definitions/AccountTimeline"
"400":
description: "Invalid account id supplied"
+ "404":
+ description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/payments:
- post:
+ /1.0/kb/accounts/{accountId}/allCustomFields:
+ get:
tags:
- "Account"
- summary: "Trigger a payment using the account external key (authorization, purchase\
- \ or credit)"
+ summary: "Retrieve account customFields"
description: ""
- operationId: "processPaymentByExternalKey"
- consumes:
- - "application/json"
+ operationId: "getAllCustomFields"
produces:
- "application/json"
parameters:
- - in: "body"
- name: "body"
- required: true
- schema:
- $ref: "#/definitions/PaymentTransaction"
- - name: "externalKey"
- in: "query"
+ - name: "accountId"
+ in: "path"
required: true
type: "string"
- - name: "paymentMethodId"
- in: "query"
- required: false
- type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "controlPluginName"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "pluginProperty"
+ - name: "objectType"
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"
+ enum:
+ - "ACCOUNT"
+ - "ACCOUNT_EMAIL"
+ - "BLOCKING_STATES"
+ - "BUNDLE"
+ - "CUSTOM_FIELD"
+ - "INVOICE"
+ - "PAYMENT"
+ - "TRANSACTION"
+ - "INVOICE_ITEM"
+ - "INVOICE_PAYMENT"
+ - "SUBSCRIPTION"
+ - "SUBSCRIPTION_EVENT"
+ - "SERVICE_BROADCAST"
+ - "PAYMENT_ATTEMPT"
+ - "PAYMENT_METHOD"
+ - "TAG"
+ - "TAG_DEFINITION"
+ - "TENANT"
+ - "TENANT_KVS"
+ - name: "audit"
+ in: "query"
required: false
type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
responses:
- "201":
- description: "Payment transaction created successfully"
+ "200":
+ description: "successful operation"
schema:
- $ref: "#/definitions/Payment"
+ type: "array"
+ items:
+ $ref: "#/definitions/CustomField"
"400":
- description: "Invalid account external key supplied"
+ description: "Invalid account id supplied"
"404":
description: "Account not found"
- "402":
- description: "Transaction declined by gateway"
- "422":
- description: "Payment is aborted by a control plugin"
- "502":
- description: "Failed to submit payment transaction"
- "503":
- description: "Payment in unknown status, failed to receive gateway response"
- "504":
- description: "Payment operation timeout"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/cbaRebalancing:
- put:
+ /1.0/kb/accounts/{accountId}/allTags:
+ get:
tags:
- "Account"
- summary: "Rebalance account CBA"
+ summary: "Retrieve account tags"
description: ""
- operationId: "rebalanceExistingCBAOnAccount"
- consumes:
- - "application/json"
+ operationId: "getAllTags"
produces:
- "application/json"
parameters:
@@ -1600,38 +1703,70 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
+ - name: "objectType"
+ in: "query"
required: false
type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
+ enum:
+ - "ACCOUNT"
+ - "ACCOUNT_EMAIL"
+ - "BLOCKING_STATES"
+ - "BUNDLE"
+ - "CUSTOM_FIELD"
+ - "INVOICE"
+ - "PAYMENT"
+ - "TRANSACTION"
+ - "INVOICE_ITEM"
+ - "INVOICE_PAYMENT"
+ - "SUBSCRIPTION"
+ - "SUBSCRIPTION_EVENT"
+ - "SERVICE_BROADCAST"
+ - "PAYMENT_ATTEMPT"
+ - "PAYMENT_METHOD"
+ - "TAG"
+ - "TAG_DEFINITION"
+ - "TENANT"
+ - "TENANT_KVS"
+ - name: "includedDeleted"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "audit"
+ in: "query"
required: false
type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
responses:
- "204":
- description: "Successful operation"
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/Tag"
"400":
description: "Invalid account id supplied"
+ "404":
+ description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/auditLogsWithHistory:
+ /1.0/kb/accounts/block/{blockingId}/auditLogsWithHistory:
get:
tags:
- "Account"
- summary: "Retrieve account audit logs with history by account id"
+ summary: "Retrieve blocking state audit logs with history by id"
description: ""
- operationId: "getAccountAuditLogsWithHistory"
+ operationId: "getBlockingStateAuditLogsWithHistory"
produces:
- "application/json"
parameters:
- - name: "accountId"
+ - name: "blockingId"
in: "path"
required: true
type: "string"
@@ -1645,18 +1780,18 @@ paths:
items:
$ref: "#/definitions/AuditLog"
"404":
- description: "Account not found"
+ description: "Blocking state not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/invoices/pagination:
+ /1.0/kb/accounts/{accountId}/invoices:
get:
tags:
- "Account"
- summary: "Retrieve paginated invoices for account"
+ summary: "Retrieve account invoices"
description: ""
- operationId: "getInvoicesForAccountPaginated"
+ operationId: "getInvoicesForAccount"
produces:
- "application/json"
parameters:
@@ -1666,18 +1801,40 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "offset"
+ - name: "startDate"
in: "query"
required: false
- type: "integer"
- default: 0
- format: "int64"
- - name: "limit"
+ type: "string"
+ format: "date"
+ - name: "endDate"
in: "query"
required: false
- type: "integer"
- default: 100
- format: "int64"
+ type: "string"
+ format: "date"
+ - name: "withMigrationInvoices"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "unpaidInvoicesOnly"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "includeVoidedInvoices"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "includeInvoiceComponents"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "invoicesFilter"
+ in: "query"
+ required: false
+ type: "string"
- name: "audit"
in: "query"
required: false
@@ -1702,13 +1859,13 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/block:
+ /1.0/kb/accounts/{accountId}/invoices/pagination:
get:
tags:
- "Account"
- summary: "Retrieve blocking states for account"
+ summary: "Retrieve paginated invoices for account"
description: ""
- operationId: "getBlockingStates"
+ operationId: "getInvoicesForAccountPaginated"
produces:
- "application/json"
parameters:
@@ -1718,24 +1875,18 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "blockingStateTypes"
+ - name: "offset"
in: "query"
required: false
- type: "array"
- items:
- type: "string"
- enum:
- - "SUBSCRIPTION"
- - "SUBSCRIPTION_BUNDLE"
- - "ACCOUNT"
- collectionFormat: "multi"
- - name: "blockingStateSvcs"
+ type: "integer"
+ default: 0
+ format: "int64"
+ - name: "limit"
in: "query"
required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
+ type: "integer"
+ default: 100
+ format: "int64"
- name: "audit"
in: "query"
required: false
@@ -1751,20 +1902,23 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/BlockingState"
+ $ref: "#/definitions/Invoice"
"400":
description: "Invalid account id supplied"
+ "404":
+ description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- post:
+ /1.0/kb/accounts/{accountId}/overdue:
+ get:
tags:
- "Account"
- summary: "Block an account"
+ summary: "Retrieve overdue state for account"
description: ""
- operationId: "addAccountBlockingState"
- consumes:
+ operationId: "getOverdueAccount"
+ produces:
- "application/json"
parameters:
- name: "accountId"
@@ -1773,42 +1927,11 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- $ref: "#/definitions/BlockingState"
- - name: "requestedDate"
- in: "query"
- required: false
- type: "string"
- format: "date"
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
responses:
- "201":
- description: "Blocking state created successfully"
+ "200":
+ description: "successful operation"
schema:
- type: "array"
- items:
- $ref: "#/definitions/BlockingState"
+ $ref: "#/definitions/OverdueState"
"400":
description: "Invalid account id supplied"
"404":
@@ -1817,13 +1940,13 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/bundles/pagination:
+ /1.0/kb/accounts/{accountId}/payments:
get:
tags:
- "Account"
- summary: "Retrieve paginated bundles for account"
+ summary: "Retrieve account payments"
description: ""
- operationId: "getAccountBundlesPaginated"
+ operationId: "getPaymentsForAccount"
produces:
- "application/json"
parameters:
@@ -1833,18 +1956,23 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "offset"
+ - name: "withAttempts"
in: "query"
required: false
- type: "integer"
- default: 0
- format: "int64"
- - name: "limit"
+ type: "boolean"
+ default: false
+ - name: "withPluginInfo"
in: "query"
required: false
- type: "integer"
- default: 100
- format: "int64"
+ type: "boolean"
+ default: false
+ - name: "pluginProperty"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
- name: "audit"
in: "query"
required: false
@@ -1860,22 +1988,21 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/Bundle"
+ $ref: "#/definitions/Payment"
"400":
description: "Invalid account id supplied"
- "404":
- description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/invoices:
- get:
+ post:
tags:
- "Account"
- summary: "Retrieve account invoices"
+ summary: "Trigger a payment (authorization, purchase or credit)"
description: ""
- operationId: "getInvoicesForAccount"
+ operationId: "processPayment"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
@@ -1885,100 +2012,150 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "startDate"
- in: "query"
- required: false
- type: "string"
- format: "date"
- - name: "endDate"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/PaymentTransaction"
+ - name: "paymentMethodId"
in: "query"
required: false
type: "string"
- format: "date"
- - name: "withMigrationInvoices"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "unpaidInvoicesOnly"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "includeVoidedInvoices"
+ format: "uuid"
+ - name: "controlPluginName"
in: "query"
required: false
- type: "boolean"
- default: false
- - name: "includeInvoiceComponents"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ - name: "pluginProperty"
in: "query"
required: false
- type: "boolean"
- default: false
- - name: "invoicesFilter"
- in: "query"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
required: false
type: "string"
- - name: "audit"
- in: "query"
+ - name: "X-Killbill-Comment"
+ in: "header"
required: false
type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
responses:
- "200":
- description: "successful operation"
+ "201":
+ description: "Payment transaction created successfully"
schema:
- type: "array"
- items:
- $ref: "#/definitions/Invoice"
+ $ref: "#/definitions/Payment"
"400":
description: "Invalid account id supplied"
"404":
description: "Account not found"
+ "402":
+ description: "Transaction declined by gateway"
+ "422":
+ description: "Payment is aborted by a control plugin"
+ "502":
+ description: "Failed to submit payment transaction"
+ "503":
+ description: "Payment in unknown status, failed to receive gateway response"
+ "504":
+ description: "Payment operation timeout"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/block/{blockingId}/auditLogsWithHistory:
- get:
+ /1.0/kb/accounts/payments:
+ post:
tags:
- "Account"
- summary: "Retrieve blocking state audit logs with history by id"
+ summary: "Trigger a payment using the account external key (authorization, purchase\
+ \ or credit)"
description: ""
- operationId: "getBlockingStateAuditLogsWithHistory"
+ operationId: "processPaymentByExternalKey"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
- - name: "blockingId"
- in: "path"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/PaymentTransaction"
+ - name: "externalKey"
+ in: "query"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ - name: "paymentMethodId"
+ in: "query"
+ required: false
+ type: "string"
format: "uuid"
+ - name: "controlPluginName"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ - name: "pluginProperty"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ required: false
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
+ required: false
+ type: "string"
responses:
- "200":
- description: "successful operation"
+ "201":
+ description: "Payment transaction created successfully"
schema:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
+ $ref: "#/definitions/Payment"
+ "400":
+ description: "Invalid account external key supplied"
"404":
- description: "Blocking state not found"
+ description: "Account not found"
+ "402":
+ description: "Transaction declined by gateway"
+ "422":
+ description: "Payment is aborted by a control plugin"
+ "502":
+ description: "Failed to submit payment transaction"
+ "503":
+ description: "Payment in unknown status, failed to receive gateway response"
+ "504":
+ description: "Payment operation timeout"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/emails/{accountEmailId}/auditLogsWithHistory:
- get:
+ /1.0/kb/accounts/{accountId}/cbaRebalancing:
+ put:
tags:
- "Account"
- summary: "Retrieve account email audit logs with history by id"
+ summary: "Rebalance account CBA"
description: ""
- operationId: "getAccountEmailAuditLogsWithHistory"
+ operationId: "rebalanceExistingCBAOnAccount"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
@@ -1988,181 +2165,89 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "accountEmailId"
- in: "path"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
- "404":
- description: "Account not found"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/auditLogs:
- get:
- tags:
- - "Account"
- summary: "Retrieve audit logs by account id"
- description: ""
- operationId: "getAccountAuditLogs"
- produces:
- - "application/json"
- parameters:
- - name: "accountId"
- in: "path"
- required: true
+ - name: "X-Killbill-Reason"
+ in: "header"
+ required: false
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
+ required: false
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
- "404":
- description: "Account not found"
+ "204":
+ description: "Successful operation"
+ "400":
+ description: "Invalid account id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{childAccountId}/transferCredit:
+ /1.0/kb/admin/healthcheck:
put:
tags:
- - "Account"
- summary: "Move a given child credit to the parent level"
+ - "Admin"
+ summary: "Put the host back into rotation"
description: ""
- operationId: "transferChildCreditToParent"
- consumes:
- - "application/json"
+ operationId: "putInRotation"
produces:
- "application/json"
- parameters:
- - name: "childAccountId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
+ parameters: []
responses:
"204":
description: "Successful operation"
- "400":
- description: "Account does not have credit"
- "404":
- description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/paymentMethods/refresh:
- put:
+ delete:
tags:
- - "Account"
- summary: "Refresh account payment methods"
+ - "Admin"
+ summary: "Put the host out of rotation"
description: ""
- operationId: "refreshPaymentMethods"
+ operationId: "putOutOfRotation"
produces:
- "application/json"
- parameters:
- - name: "accountId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "pluginName"
- in: "query"
- required: false
- type: "string"
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
+ parameters: []
responses:
"204":
description: "Successful operation"
- "400":
- description: "Invalid account id supplied"
- "404":
- description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/paymentMethods/{paymentMethodId}/setDefault:
+ /1.0/kb/admin/payments/{paymentId}/transactions/{paymentTransactionId}:
put:
tags:
- - "Account"
- summary: "Set the default payment method"
+ - "Admin"
+ summary: "Update existing paymentTransaction and associated payment state"
description: ""
- operationId: "setDefaultPaymentMethod"
+ operationId: "updatePaymentTransactionState"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- - name: "accountId"
+ - name: "paymentId"
in: "path"
required: true
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "paymentMethodId"
+ - name: "paymentTransactionId"
in: "path"
required: true
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "payAllUnpaidInvoices"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/AdminPayment"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -2179,42 +2264,7 @@ paths:
"204":
description: "Successful operation"
"400":
- description: "Invalid account id or payment method id supplied"
- "404":
- description: "Account not found"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/admin/healthcheck:
- put:
- tags:
- - "Admin"
- summary: "Put the host back into rotation"
- description: ""
- operationId: "putInRotation"
- produces:
- - "application/json"
- parameters: []
- responses:
- "204":
- description: "Successful operation"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- delete:
- tags:
- - "Admin"
- summary: "Put the host out of rotation"
- description: ""
- operationId: "putOutOfRotation"
- produces:
- - "application/json"
- parameters: []
- responses:
- "204":
- description: "Successful operation"
+ description: "Invalid account data supplied"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -2305,23 +2355,6 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/admin/cache/tenants:
- delete:
- tags:
- - "Admin"
- summary: "Invalidates Caches per tenant level"
- description: ""
- operationId: "invalidatesCacheByTenant"
- produces:
- - "application/json"
- parameters: []
- responses:
- "204":
- description: "Successful operation"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
/1.0/kb/admin/cache/accounts/{accountId}:
delete:
tags:
@@ -2347,52 +2380,19 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/admin/payments/{paymentId}/transactions/{paymentTransactionId}:
- put:
+ /1.0/kb/admin/cache/tenants:
+ delete:
tags:
- "Admin"
- summary: "Update existing paymentTransaction and associated payment state"
+ summary: "Invalidates Caches per tenant level"
description: ""
- operationId: "updatePaymentTransactionState"
- consumes:
- - "application/json"
+ operationId: "invalidatesCacheByTenant"
produces:
- "application/json"
- parameters:
- - name: "paymentId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "paymentTransactionId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- $ref: "#/definitions/AdminPayment"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
+ parameters: []
responses:
"204":
description: "Successful operation"
- "400":
- description: "Invalid account data supplied"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -2704,28 +2704,22 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/bundles/pagination:
+ /1.0/kb/bundles/{bundleId}/customFields:
get:
tags:
- "Bundle"
- summary: "List bundles"
+ summary: "Retrieve bundle custom fields"
description: ""
- operationId: "getBundles"
+ operationId: "getBundleCustomFields"
produces:
- "application/json"
parameters:
- - name: "offset"
- in: "query"
- required: false
- type: "integer"
- default: 0
- format: "int64"
- - name: "limit"
- in: "query"
- required: false
- type: "integer"
- default: 100
- format: "int64"
+ - name: "bundleId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
- name: "audit"
in: "query"
required: false
@@ -2741,59 +2735,68 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/Bundle"
+ $ref: "#/definitions/CustomField"
+ "400":
+ description: "Invalid bundle id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/bundles:
- get:
+ post:
tags:
- "Bundle"
- summary: "Retrieve a bundle by external key"
+ summary: "Add custom fields to bundle"
description: ""
- operationId: "getBundleByKey"
+ operationId: "createBundleCustomFields"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
- - name: "externalKey"
- in: "query"
+ - name: "bundleId"
+ in: "path"
required: true
type: "string"
- - name: "includedDeleted"
- in: "query"
+ 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: "boolean"
- default: false
- - name: "audit"
- in: "query"
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
required: false
type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
responses:
- "200":
- description: "successful operation"
+ "201":
+ description: "Custom field created successfully"
schema:
type: "array"
items:
- $ref: "#/definitions/Bundle"
- "404":
- description: "Bundle not found"
+ $ref: "#/definitions/CustomField"
+ "400":
+ description: "Invalid bundle id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/bundles/{bundleId}/pause:
put:
tags:
- "Bundle"
- summary: "Pause a bundle"
+ summary: "Modify custom fields to bundle"
description: ""
- operationId: "pauseBundle"
+ operationId: "modifyBundleCustomFields"
consumes:
- "application/json"
produces:
@@ -2805,17 +2808,58 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "requestedDate"
- in: "query"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/CustomField"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
required: false
type: "string"
- format: "date"
- - name: "pluginProperty"
+ - name: "X-Killbill-Comment"
+ in: "header"
+ required: false
+ type: "string"
+ responses:
+ "204":
+ description: "Successful operation"
+ "400":
+ description: "Invalid bundle id supplied"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ delete:
+ tags:
+ - "Bundle"
+ summary: "Remove custom fields from bundle"
+ description: ""
+ operationId: "deleteBundleCustomFields"
+ consumes:
+ - "application/json"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "bundleId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - name: "customField"
in: "query"
required: false
type: "array"
items:
type: "string"
+ format: "uuid"
collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
@@ -2834,27 +2878,61 @@ paths:
description: "Successful operation"
"400":
description: "Invalid bundle id supplied"
- "404":
- description: "Bundle not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/bundles/search/{searchKey}:
+ /1.0/kb/bundles:
get:
tags:
- "Bundle"
- summary: "Search bundles"
+ summary: "Retrieve a bundle by external key"
description: ""
- operationId: "searchBundles"
+ operationId: "getBundleByKey"
produces:
- "application/json"
parameters:
- - name: "searchKey"
- in: "path"
+ - name: "externalKey"
+ in: "query"
required: true
type: "string"
- pattern: ".*"
+ - name: "includedDeleted"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "audit"
+ in: "query"
+ required: false
+ type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/Bundle"
+ "404":
+ description: "Bundle not found"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ /1.0/kb/bundles/pagination:
+ get:
+ tags:
+ - "Bundle"
+ summary: "List bundles"
+ description: ""
+ operationId: "getBundles"
+ produces:
+ - "application/json"
+ parameters:
- name: "offset"
in: "query"
required: false
@@ -2887,13 +2965,13 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/bundles/{bundleId}/resume:
+ /1.0/kb/bundles/{bundleId}/pause:
put:
tags:
- "Bundle"
- summary: "Resume a bundle"
+ summary: "Pause a bundle"
description: ""
- operationId: "resumeBundle"
+ operationId: "pauseBundle"
consumes:
- "application/json"
produces:
@@ -2984,15 +3062,17 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/bundles/{bundleId}/block:
- post:
+ /1.0/kb/bundles/{bundleId}/resume:
+ put:
tags:
- "Bundle"
- summary: "Block a bundle"
+ summary: "Resume a bundle"
description: ""
- operationId: "addBundleBlockingState"
+ operationId: "resumeBundle"
consumes:
- "application/json"
+ produces:
+ - "application/json"
parameters:
- name: "bundleId"
in: "path"
@@ -3000,11 +3080,6 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- $ref: "#/definitions/BlockingState"
- name: "requestedDate"
in: "query"
required: false
@@ -3030,12 +3105,8 @@ paths:
required: false
type: "string"
responses:
- "201":
- description: "Blocking state created successfully"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/BlockingState"
+ "204":
+ description: "Successful operation"
"400":
description: "Invalid bundle id supplied"
"404":
@@ -3044,22 +3115,33 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/bundles/{bundleId}/customFields:
+ /1.0/kb/bundles/search/{searchKey}:
get:
tags:
- "Bundle"
- summary: "Retrieve bundle custom fields"
+ summary: "Search bundles"
description: ""
- operationId: "getBundleCustomFields"
+ operationId: "searchBundles"
produces:
- "application/json"
parameters:
- - name: "bundleId"
+ - name: "searchKey"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
+ pattern: ".*"
+ - name: "offset"
+ in: "query"
+ required: false
+ type: "integer"
+ default: 0
+ format: "int64"
+ - name: "limit"
+ in: "query"
+ required: false
+ type: "integer"
+ default: 100
+ format: "int64"
- name: "audit"
in: "query"
required: false
@@ -3075,23 +3157,20 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/CustomField"
- "400":
- description: "Invalid bundle id supplied"
+ $ref: "#/definitions/Bundle"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ /1.0/kb/bundles/{bundleId}/block:
post:
tags:
- "Bundle"
- summary: "Add custom fields to bundle"
+ summary: "Block a bundle"
description: ""
- operationId: "createBundleCustomFields"
+ operationId: "addBundleBlockingState"
consumes:
- "application/json"
- produces:
- - "application/json"
parameters:
- name: "bundleId"
in: "path"
@@ -3103,9 +3182,19 @@ paths:
name: "body"
required: true
schema:
- type: "array"
- items:
- $ref: "#/definitions/CustomField"
+ $ref: "#/definitions/BlockingState"
+ - name: "requestedDate"
+ in: "query"
+ required: false
+ type: "string"
+ format: "date"
+ - name: "pluginProperty"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -3120,25 +3209,26 @@ paths:
type: "string"
responses:
"201":
- description: "Custom field created successfully"
+ description: "Blocking state created successfully"
schema:
type: "array"
items:
- $ref: "#/definitions/CustomField"
+ $ref: "#/definitions/BlockingState"
"400":
description: "Invalid bundle id supplied"
+ "404":
+ description: "Bundle not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- put:
+ /1.0/kb/bundles/{bundleId}/auditLogsWithHistory:
+ get:
tags:
- "Bundle"
- summary: "Modify custom fields to bundle"
+ summary: "Retrieve bundle audit logs with history by id"
description: ""
- operationId: "modifyBundleCustomFields"
- consumes:
- - "application/json"
+ operationId: "getBundleAuditLogsWithHistory"
produces:
- "application/json"
parameters:
@@ -3148,59 +3238,36 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- type: "array"
- items:
- $ref: "#/definitions/CustomField"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
responses:
- "204":
- description: "Successful operation"
- "400":
- description: "Invalid bundle id supplied"
+ "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: []
- delete:
+ /1.0/kb/catalog/simplePlan:
+ post:
tags:
- - "Bundle"
- summary: "Remove custom fields from bundle"
+ - "Catalog"
+ summary: "Add a simple plan entry in the current version of the catalog"
description: ""
- operationId: "deleteBundleCustomFields"
+ operationId: "addSimplePlan"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- - name: "bundleId"
- in: "path"
+ - in: "body"
+ name: "body"
required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "customField"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- format: "uuid"
- collectionFormat: "multi"
+ schema:
+ $ref: "#/definitions/SimplePlan"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -3214,29 +3281,33 @@ paths:
required: false
type: "string"
responses:
- "204":
- description: "Successful operation"
- "400":
- description: "Invalid bundle id supplied"
+ "201":
+ description: "Created new plan successfully"
+ schema:
+ type: "string"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/bundles/{bundleId}/auditLogsWithHistory:
+ /1.0/kb/catalog:
get:
tags:
- - "Bundle"
- summary: "Retrieve bundle audit logs with history by id"
+ - "Catalog"
+ summary: "Retrieve the catalog as JSON"
description: ""
- operationId: "getBundleAuditLogsWithHistory"
+ operationId: "getCatalogJson"
produces:
- "application/json"
parameters:
- - name: "bundleId"
- in: "path"
- required: true
+ - name: "requestedDate"
+ in: "query"
+ required: false
+ type: "string"
+ format: "date-time"
+ - name: "accountId"
+ in: "query"
+ required: false
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
responses:
"200":
@@ -3244,9 +3315,33 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/AuditLog"
- "404":
- description: "Subscription bundle not found"
+ $ref: "#/definitions/Catalog"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ delete:
+ tags:
+ - "Catalog"
+ summary: "Delete all versions for a per tenant catalog"
+ description: ""
+ operationId: "deleteCatalog"
+ parameters:
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ required: false
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
+ required: false
+ type: "string"
+ responses:
+ "204":
+ description: "Successful operation"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -3285,21 +3380,16 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/catalog:
+ /1.0/kb/catalog/availableBasePlans:
get:
tags:
- "Catalog"
- summary: "Retrieve the catalog as JSON"
+ summary: "Retrieve available base plans"
description: ""
- operationId: "getCatalogJson"
+ operationId: "getAvailableBasePlans"
produces:
- "application/json"
parameters:
- - name: "requestedDate"
- in: "query"
- required: false
- type: "string"
- format: "date-time"
- name: "accountId"
in: "query"
required: false
@@ -3311,33 +3401,7 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/Catalog"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- delete:
- tags:
- - "Catalog"
- summary: "Delete all versions for a per tenant catalog"
- description: ""
- operationId: "deleteCatalog"
- parameters:
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
- responses:
- "204":
- description: "Successful operation"
+ $ref: "#/definitions/PlanDetail"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -3433,66 +3497,31 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /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"
- required: true
- schema:
- type: "string"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
- responses:
- "200":
- description: "successful operation"
- schema:
- $ref: "#/definitions/CatalogValidation"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/catalog/availableBasePlans:
+ /1.0/kb/catalog/phase:
get:
tags:
- "Catalog"
- summary: "Retrieve available base plans"
+ summary: "Retrieve phase for a given subscription and date"
description: ""
- operationId: "getAvailableBasePlans"
+ operationId: "getPhaseForSubscriptionAndDate"
produces:
- "application/json"
parameters:
- - name: "accountId"
+ - name: "subscriptionId"
in: "query"
required: false
type: "string"
format: "uuid"
+ - name: "requestedDate"
+ in: "query"
+ required: false
+ type: "string"
+ format: "date"
responses:
"200":
description: "successful operation"
schema:
- type: "array"
- items:
- $ref: "#/definitions/PlanDetail"
+ $ref: "#/definitions/Phase"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -3584,74 +3613,45 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/catalog/phase:
- get:
+ /1.0/kb/catalog/xml/validate:
+ post:
tags:
- "Catalog"
- summary: "Retrieve phase for a given subscription and date"
+ summary: "Validate a XML catalog"
description: ""
- operationId: "getPhaseForSubscriptionAndDate"
+ operationId: "validateCatalogXml"
+ consumes:
+ - "text/xml"
produces:
- "application/json"
parameters:
- - name: "subscriptionId"
- in: "query"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ type: "string"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
required: false
type: "string"
- format: "uuid"
- - name: "requestedDate"
- in: "query"
+ - name: "X-Killbill-Comment"
+ in: "header"
required: false
type: "string"
- format: "date"
responses:
"200":
description: "successful operation"
schema:
- $ref: "#/definitions/Phase"
+ $ref: "#/definitions/CatalogValidation"
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/credits:
+ /1.0/kb/credits:
post:
tags:
- "Credit"
@@ -3743,28 +3743,16 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/customFields/search:
+ /1.0/kb/customFields/pagination:
get:
tags:
- "CustomField"
- summary: "Search custom fields by type, name and optional value"
+ summary: "List custom fields"
description: ""
- operationId: "searchCustomFieldsByTypeName"
+ operationId: "getCustomFields"
produces:
- "application/json"
parameters:
- - name: "objectType"
- in: "query"
- required: false
- type: "string"
- - name: "fieldName"
- in: "query"
- required: false
- type: "string"
- - name: "fieldValue"
- in: "query"
- required: false
- type: "string"
- name: "offset"
in: "query"
required: false
@@ -3797,45 +3785,21 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/customFields/{customFieldId}/auditLogsWithHistory:
+ /1.0/kb/customFields/search/{searchKey}:
get:
tags:
- "CustomField"
- summary: "Retrieve custom field audit logs with history by id"
+ summary: "Search custom fields"
description: ""
- operationId: "getCustomFieldAuditLogsWithHistory"
+ operationId: "searchCustomFields"
produces:
- "application/json"
parameters:
- - name: "customFieldId"
+ - name: "searchKey"
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/pagination:
- get:
- tags:
- - "CustomField"
- summary: "List custom fields"
- description: ""
- operationId: "getCustomFields"
- produces:
- - "application/json"
- parameters:
+ pattern: ".*"
- name: "offset"
in: "query"
required: false
@@ -3868,21 +3832,57 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/customFields/search/{searchKey}:
+ /1.0/kb/customFields/{customFieldId}/auditLogsWithHistory:
get:
tags:
- "CustomField"
- summary: "Search custom fields"
+ summary: "Retrieve custom field audit logs with history by id"
description: ""
- operationId: "searchCustomFields"
+ operationId: "getCustomFieldAuditLogsWithHistory"
produces:
- "application/json"
parameters:
- - name: "searchKey"
+ - name: "customFieldId"
in: "path"
required: true
type: "string"
- pattern: ".*"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/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"
+ - name: "fieldName"
+ in: "query"
+ required: false
+ type: "string"
+ - name: "fieldValue"
+ in: "query"
+ required: false
+ type: "string"
- name: "offset"
in: "query"
required: false
@@ -3954,13 +3954,13 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoiceItems/{invoiceItemId}/customFields:
+ /1.0/kb/invoiceItems/{invoiceItemId}/tags:
get:
tags:
- "InvoiceItem"
- summary: "Retrieve invoice item custom fields"
+ summary: "Retrieve invoice item tags"
description: ""
- operationId: "getInvoiceItemCustomFields"
+ operationId: "getInvoiceItemTags"
produces:
- "application/json"
parameters:
@@ -3970,6 +3970,16 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ - name: "accountId"
+ in: "query"
+ required: true
+ type: "string"
+ format: "uuid"
+ - name: "includedDeleted"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
- name: "audit"
in: "query"
required: false
@@ -3985,9 +3995,11 @@ 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: []
@@ -3995,9 +4007,9 @@ paths:
post:
tags:
- "InvoiceItem"
- summary: "Add custom fields to invoice item"
+ summary: "Add tags to invoice item"
description: ""
- operationId: "createInvoiceItemCustomFields"
+ operationId: "createInvoiceItemTags"
consumes:
- "application/json"
produces:
@@ -4015,7 +4027,8 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/CustomField"
+ type: "string"
+ format: "uuid"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -4030,56 +4043,11 @@ paths:
type: "string"
responses:
"201":
- description: "Custom field created successfully"
+ description: "Tag created successfully"
schema:
type: "array"
items:
- $ref: "#/definitions/CustomField"
- "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"
+ $ref: "#/definitions/Tag"
"400":
description: "Invalid invoice item id supplied"
security:
@@ -4089,9 +4057,9 @@ paths:
delete:
tags:
- "InvoiceItem"
- summary: "Remove custom fields from invoice item"
+ summary: "Remove tags from invoice item"
description: ""
- operationId: "deleteInvoiceItemCustomFields"
+ operationId: "deleteInvoiceItemTags"
consumes:
- "application/json"
produces:
@@ -4103,7 +4071,7 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "customField"
+ - name: "tagDef"
in: "query"
required: false
type: "array"
@@ -4132,13 +4100,13 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoiceItems/{invoiceItemId}/auditLogsWithHistory:
+ /1.0/kb/invoiceItems/{invoiceItemId}/customFields:
get:
tags:
- "InvoiceItem"
- summary: "Retrieve invoice item audit logs with history by id"
+ summary: "Retrieve invoice item custom fields"
description: ""
- operationId: "getInvoiceItemAuditLogsWithHistory"
+ operationId: "getInvoiceItemCustomFields"
produces:
- "application/json"
parameters:
@@ -4148,26 +4116,36 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ - name: "audit"
+ in: "query"
+ required: false
+ type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
responses:
"200":
description: "successful operation"
schema:
type: "array"
items:
- $ref: "#/definitions/AuditLog"
- "404":
- description: "Invoice item not found"
+ $ref: "#/definitions/CustomField"
+ "400":
+ description: "Invalid invoice item id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoiceItems/{invoiceItemId}/tags:
- get:
+ post:
tags:
- "InvoiceItem"
- summary: "Retrieve invoice item tags"
+ summary: "Add custom fields to invoice item"
description: ""
- operationId: "getInvoiceItemTags"
+ operationId: "createInvoiceItemCustomFields"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
@@ -4177,46 +4155,44 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "accountId"
- in: "query"
+ - in: "body"
+ name: "body"
required: true
- type: "string"
- format: "uuid"
- - name: "includedDeleted"
- in: "query"
+ 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: "boolean"
- default: false
- - name: "audit"
- in: "query"
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
required: false
type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
responses:
- "200":
- description: "successful operation"
+ "201":
+ description: "Custom field created successfully"
schema:
type: "array"
items:
- $ref: "#/definitions/Tag"
+ $ref: "#/definitions/CustomField"
"400":
description: "Invalid invoice item id supplied"
- "404":
- description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- post:
+ put:
tags:
- "InvoiceItem"
- summary: "Add tags to invoice item"
+ summary: "Modify custom fields to invoice item"
description: ""
- operationId: "createInvoiceItemTags"
+ operationId: "modifyInvoiceItemCustomFields"
consumes:
- "application/json"
produces:
@@ -4234,8 +4210,7 @@ paths:
schema:
type: "array"
items:
- type: "string"
- format: "uuid"
+ $ref: "#/definitions/CustomField"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -4249,12 +4224,8 @@ paths:
required: false
type: "string"
responses:
- "201":
- description: "Tag created successfully"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/Tag"
+ "204":
+ description: "Successful operation"
"400":
description: "Invalid invoice item id supplied"
security:
@@ -4264,9 +4235,9 @@ paths:
delete:
tags:
- "InvoiceItem"
- summary: "Remove tags from invoice item"
+ summary: "Remove custom fields from invoice item"
description: ""
- operationId: "deleteInvoiceItemTags"
+ operationId: "deleteInvoiceItemCustomFields"
consumes:
- "application/json"
produces:
@@ -4278,7 +4249,7 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "tagDef"
+ - name: "customField"
in: "query"
required: false
type: "array"
@@ -4307,13 +4278,42 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoicePayments/{paymentId}:
+ /1.0/kb/invoiceItems/{invoiceItemId}/auditLogsWithHistory:
+ get:
+ tags:
+ - "InvoiceItem"
+ summary: "Retrieve invoice item audit logs with history by id"
+ description: ""
+ operationId: "getInvoiceItemAuditLogsWithHistory"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "invoiceItemId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/AuditLog"
+ "404":
+ description: "Invoice item not found"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ /1.0/kb/invoicePayments/{paymentId}/tags:
get:
tags:
- "InvoicePayment"
- summary: "Retrieve a payment by id"
+ summary: "Retrieve payment tags"
description: ""
- operationId: "getInvoicePayment"
+ operationId: "getInvoicePaymentTags"
produces:
- "application/json"
parameters:
@@ -4323,12 +4323,7 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "withPluginInfo"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "withAttempts"
+ - name: "includedDeleted"
in: "query"
required: false
type: "boolean"
@@ -4353,7 +4348,9 @@ paths:
"200":
description: "successful operation"
schema:
- $ref: "#/definitions/InvoicePayment"
+ type: "array"
+ items:
+ $ref: "#/definitions/Tag"
"400":
description: "Invalid payment id supplied"
"404":
@@ -4362,12 +4359,12 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- put:
+ post:
tags:
- "InvoicePayment"
- summary: "Complete an existing transaction"
+ summary: "Add tags to payment"
description: ""
- operationId: "completeInvoicePaymentTransaction"
+ operationId: "createInvoicePaymentTags"
consumes:
- "application/json"
produces:
@@ -4383,20 +4380,59 @@ paths:
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"
required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "pluginProperty"
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
+ required: false
+ type: "string"
+ responses:
+ "201":
+ description: "Tag created successfully"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/Tag"
+ "400":
+ description: "Invalid payment id supplied"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ delete:
+ tags:
+ - "InvoicePayment"
+ summary: "Remove tags from payment"
+ description: ""
+ operationId: "deleteInvoicePaymentTags"
+ consumes:
+ - "application/json"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "paymentId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - name: "tagDef"
in: "query"
required: false
type: "array"
items:
type: "string"
+ format: "uuid"
collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
@@ -4414,19 +4450,7 @@ paths:
"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"
+ description: "Invalid payment id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -4609,13 +4633,13 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoicePayments/{paymentId}/tags:
+ /1.0/kb/invoicePayments/{paymentId}:
get:
tags:
- "InvoicePayment"
- summary: "Retrieve payment tags"
+ summary: "Retrieve a payment by id"
description: ""
- operationId: "getInvoicePaymentTags"
+ operationId: "getInvoicePayment"
produces:
- "application/json"
parameters:
@@ -4625,7 +4649,12 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "includedDeleted"
+ - name: "withPluginInfo"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "withAttempts"
in: "query"
required: false
type: "boolean"
@@ -4650,9 +4679,7 @@ paths:
"200":
description: "successful operation"
schema:
- type: "array"
- items:
- $ref: "#/definitions/Tag"
+ $ref: "#/definitions/InvoicePayment"
"400":
description: "Invalid payment id supplied"
"404":
@@ -4661,12 +4688,12 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- post:
+ put:
tags:
- "InvoicePayment"
- summary: "Add tags to payment"
+ summary: "Complete an existing transaction"
description: ""
- operationId: "createInvoicePaymentTags"
+ operationId: "completeInvoicePaymentTransaction"
consumes:
- "application/json"
produces:
@@ -4682,10 +4709,21 @@ paths:
name: "body"
required: true
schema:
- type: "array"
- items:
- type: "string"
- format: "uuid"
+ $ref: "#/definitions/PaymentTransaction"
+ - name: "controlPluginName"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ - name: "pluginProperty"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -4699,24 +4737,33 @@ paths:
required: false
type: "string"
responses:
- "201":
- description: "Tag created successfully"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/Tag"
+ "204":
+ description: "Successful operation"
"400":
- description: "Invalid payment id supplied"
+ description: "Invalid paymentId supplied"
+ "404":
+ description: "Account or payment not found"
+ "402":
+ description: "Transaction declined by gateway"
+ "422":
+ description: "Payment is aborted by a control plugin"
+ "502":
+ description: "Failed to submit payment transaction"
+ "503":
+ description: "Payment in unknown status, failed to receive gateway response"
+ "504":
+ description: "Payment operation timeout"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- delete:
+ /1.0/kb/invoicePayments/{paymentId}/chargebacks:
+ post:
tags:
- "InvoicePayment"
- summary: "Remove tags from payment"
+ summary: "Record a chargeback"
description: ""
- operationId: "deleteInvoicePaymentTags"
+ operationId: "createChargeback"
consumes:
- "application/json"
produces:
@@ -4728,13 +4775,17 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "tagDef"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/InvoicePaymentTransaction"
+ - name: "pluginProperty"
in: "query"
required: false
type: "array"
items:
type: "string"
- format: "uuid"
collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
@@ -4749,21 +4800,25 @@ paths:
required: false
type: "string"
responses:
- "204":
- description: "Successful operation"
- "400":
+ "201":
+ description: "Created chargeback successfully"
+ schema:
+ $ref: "#/definitions/InvoicePayment"
+ "400":
description: "Invalid payment id supplied"
+ "404":
+ description: "Account or payment not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoicePayments/{paymentId}/refunds:
+ /1.0/kb/invoicePayments/{paymentId}/chargebackReversals:
post:
tags:
- "InvoicePayment"
- summary: "Refund a payment, and adjust the invoice if needed"
+ summary: "Record a chargebackReversal"
description: ""
- operationId: "createRefundWithAdjustments"
+ operationId: "createChargebackReversal"
consumes:
- "application/json"
produces:
@@ -4780,16 +4835,6 @@ paths:
required: true
schema:
$ref: "#/definitions/InvoicePaymentTransaction"
- - name: "externalPayment"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "paymentMethodId"
- in: "query"
- required: false
- type: "string"
- format: "uuid"
- name: "pluginProperty"
in: "query"
required: false
@@ -4811,7 +4856,7 @@ paths:
type: "string"
responses:
"201":
- description: "Created refund successfully"
+ description: "Created chargeback reversal successfully"
schema:
$ref: "#/definitions/InvoicePayment"
"400":
@@ -4822,42 +4867,13 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /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"
- responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
- "404":
- description: "Invoice payment not found"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/invoicePayments/{paymentId}/chargebacks:
+ /1.0/kb/invoicePayments/{paymentId}/refunds:
post:
tags:
- "InvoicePayment"
- summary: "Record a chargeback"
+ summary: "Refund a payment, and adjust the invoice if needed"
description: ""
- operationId: "createChargeback"
+ operationId: "createRefundWithAdjustments"
consumes:
- "application/json"
produces:
@@ -4874,6 +4890,16 @@ paths:
required: true
schema:
$ref: "#/definitions/InvoicePaymentTransaction"
+ - name: "externalPayment"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "paymentMethodId"
+ in: "query"
+ required: false
+ type: "string"
+ format: "uuid"
- name: "pluginProperty"
in: "query"
required: false
@@ -4895,7 +4921,7 @@ paths:
type: "string"
responses:
"201":
- description: "Created chargeback successfully"
+ description: "Created refund successfully"
schema:
$ref: "#/definitions/InvoicePayment"
"400":
@@ -4906,57 +4932,31 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoicePayments/{paymentId}/chargebackReversals:
- post:
+ /1.0/kb/invoicePayments/{invoicePaymentId}/auditLogsWithHistory:
+ get:
tags:
- "InvoicePayment"
- summary: "Record a chargebackReversal"
+ summary: "Retrieve invoice payment audit logs with history by id"
description: ""
- operationId: "createChargebackReversal"
- consumes:
- - "application/json"
+ operationId: "getInvoicePaymentAuditLogsWithHistory"
produces:
- "application/json"
parameters:
- - name: "paymentId"
+ - name: "invoicePaymentId"
in: "path"
required: true
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- $ref: "#/definitions/InvoicePaymentTransaction"
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
responses:
- "201":
- description: "Created chargeback reversal successfully"
+ "200":
+ description: "successful operation"
schema:
- $ref: "#/definitions/InvoicePayment"
- "400":
- description: "Invalid payment id supplied"
+ type: "array"
+ items:
+ $ref: "#/definitions/AuditLog"
"404":
- description: "Account or payment not found"
+ description: "Invoice payment not found"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -5102,27 +5102,22 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoices/byItemId/{itemId}:
+ /1.0/kb/invoices/{invoiceId}/customFields:
get:
tags:
- "Invoice"
- summary: "Retrieve an invoice by invoice item id"
+ summary: "Retrieve invoice custom fields"
description: ""
- operationId: "getInvoiceByItemId"
+ operationId: "getInvoiceCustomFields"
produces:
- "application/json"
parameters:
- - name: "itemId"
+ - name: "invoiceId"
in: "path"
required: true
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "withChildrenItems"
- in: "query"
- required: false
- type: "boolean"
- default: false
- name: "audit"
in: "query"
required: false
@@ -5136,30 +5131,11 @@ paths:
"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/template:
- get:
- tags:
- - "Invoice"
- summary: "Retrieves the invoice template for the tenant"
- description: ""
- operationId: "getInvoiceTemplate"
- produces:
- - "text/html"
- parameters: []
- responses:
- "200":
- description: "successful operation"
- schema:
- type: "string"
- "404":
- description: "Template not found"
+ type: "array"
+ items:
+ $ref: "#/definitions/CustomField"
+ "400":
+ description: "Invalid invoice id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -5167,24 +5143,27 @@ paths:
post:
tags:
- "Invoice"
- summary: "Upload the invoice template for the tenant"
+ summary: "Add custom fields to invoice"
description: ""
- operationId: "uploadInvoiceTemplate"
+ operationId: "createInvoiceCustomFields"
consumes:
- - "text/html"
+ - "application/json"
produces:
- - "text/html"
+ - "application/json"
parameters:
+ - name: "invoiceId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
- in: "body"
name: "body"
required: true
schema:
- type: "string"
- - name: "deleteIfExists"
- in: "query"
- required: false
- type: "boolean"
- default: false
+ type: "array"
+ items:
+ $ref: "#/definitions/CustomField"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -5199,20 +5178,25 @@ paths:
type: "string"
responses:
"201":
- description: "Uploaded invoice template Successfully"
+ description: "Custom field created successfully"
schema:
- type: "string"
+ type: "array"
+ items:
+ $ref: "#/definitions/CustomField"
+ "400":
+ description: "Invalid invoice id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoices/{invoiceId}:
- get:
+ put:
tags:
- "Invoice"
- summary: "Retrieve an invoice by id"
+ summary: "Modify custom fields to invoice"
description: ""
- operationId: "getInvoice"
+ operationId: "modifyInvoiceCustomFields"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
@@ -5222,39 +5206,40 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "withChildrenItems"
- in: "query"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/CustomField"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
required: false
- type: "boolean"
- default: false
- - name: "audit"
- in: "query"
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
required: false
type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
responses:
- "200":
- description: "successful operation"
- schema:
- $ref: "#/definitions/Invoice"
+ "204":
+ description: "Successful operation"
"400":
description: "Invalid invoice id supplied"
- "404":
- description: "Invoice not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- post:
+ delete:
tags:
- "Invoice"
- summary: "Adjust an invoice item"
+ summary: "Remove custom fields from invoice"
description: ""
- operationId: "adjustInvoiceItem"
+ operationId: "deleteInvoiceCustomFields"
consumes:
- "application/json"
produces:
@@ -5266,22 +5251,13 @@ paths:
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"
+ - name: "customField"
in: "query"
required: false
type: "array"
items:
type: "string"
+ format: "uuid"
collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
@@ -5296,60 +5272,32 @@ paths:
required: false
type: "string"
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/taxes/{accountId}:
- post:
+ /1.0/kb/invoices/{invoiceId}/commitInvoice:
+ put:
tags:
- "Invoice"
- summary: "Create tax items"
+ summary: "Perform the invoice status transition from DRAFT to COMMITTED"
description: ""
- operationId: "createTaxItems"
+ operationId: "commitInvoice"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- - name: "accountId"
+ - name: "invoiceId"
in: "path"
required: true
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- type: "array"
- items:
- $ref: "#/definitions/InvoiceItem"
- - name: "autoCommit"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "requestedDate"
- in: "query"
- required: false
- type: "string"
- format: "date"
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -5363,46 +5311,77 @@ paths:
required: false
type: "string"
responses:
- "201":
- description: "Create tax items successfully"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/InvoiceItem"
- "400":
- description: "Invalid account id supplied"
+ "204":
+ description: "Successful operation"
"404":
- description: "Account not found"
+ description: "Invoice not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoices/{groupId}/group:
- get:
+ /1.0/kb/invoices/{invoiceId}/voidInvoice:
+ put:
tags:
- "Invoice"
- summary: "Retrieve a set of invoices by group id"
+ summary: "Perform the action of voiding an invoice"
description: ""
- operationId: "getInvoicesGroup"
+ operationId: "voidInvoice"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
- - name: "groupId"
+ - name: "invoiceId"
in: "path"
required: true
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "accountId"
- in: "query"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
required: true
type: "string"
- format: "uuid"
- - name: "withChildrenItems"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ required: false
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
+ required: false
+ type: "string"
+ responses:
+ "204":
+ description: "Successful operation"
+ "400":
+ description: "Invalid invoice id supplied"
+ "404":
+ description: "Invoice not found"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ /1.0/kb/invoices/pagination:
+ get:
+ tags:
+ - "Invoice"
+ summary: "List invoices"
+ description: ""
+ operationId: "getInvoices"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "offset"
in: "query"
required: false
- type: "boolean"
- default: false
+ type: "integer"
+ default: 0
+ format: "int64"
+ - name: "limit"
+ in: "query"
+ required: false
+ type: "integer"
+ default: 100
+ format: "int64"
- name: "audit"
in: "query"
required: false
@@ -5419,28 +5398,37 @@ paths:
type: "array"
items:
$ref: "#/definitions/Invoice"
- "400":
- description: "Invalid group id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoices/{invoiceId}/customFields:
+ /1.0/kb/invoices/search/{searchKey}:
get:
tags:
- "Invoice"
- summary: "Retrieve invoice custom fields"
+ summary: "Search invoices"
description: ""
- operationId: "getInvoiceCustomFields"
+ operationId: "searchInvoices"
produces:
- "application/json"
parameters:
- - name: "invoiceId"
+ - name: "searchKey"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
+ pattern: ".*"
+ - name: "offset"
+ in: "query"
+ required: false
+ type: "integer"
+ default: 0
+ format: "int64"
+ - name: "limit"
+ in: "query"
+ required: false
+ type: "integer"
+ default: 100
+ format: "int64"
- name: "audit"
in: "query"
required: false
@@ -5456,21 +5444,18 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/CustomField"
- "400":
- description: "Invalid invoice id supplied"
+ $ref: "#/definitions/Invoice"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- post:
+ /1.0/kb/invoices/{invoiceId}:
+ get:
tags:
- "Invoice"
- summary: "Add custom fields to invoice"
+ summary: "Retrieve an invoice by id"
description: ""
- operationId: "createInvoiceCustomFields"
- consumes:
- - "application/json"
+ operationId: "getInvoice"
produces:
- "application/json"
parameters:
@@ -5480,44 +5465,39 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- type: "array"
- items:
- $ref: "#/definitions/CustomField"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
+ - name: "withChildrenItems"
+ in: "query"
required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
+ type: "boolean"
+ default: false
+ - name: "audit"
+ in: "query"
required: false
type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
responses:
- "201":
- description: "Custom field created successfully"
+ "200":
+ description: "successful operation"
schema:
- type: "array"
- items:
- $ref: "#/definitions/CustomField"
+ $ref: "#/definitions/Invoice"
"400":
description: "Invalid invoice id supplied"
+ "404":
+ description: "Invoice not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- put:
+ post:
tags:
- "Invoice"
- summary: "Modify custom fields to invoice"
+ summary: "Adjust an invoice item"
description: ""
- operationId: "modifyInvoiceCustomFields"
+ operationId: "adjustInvoiceItem"
consumes:
- "application/json"
produces:
@@ -5533,54 +5513,18 @@ paths:
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"
+ $ref: "#/definitions/InvoiceItem"
+ - name: "requestedDate"
+ in: "query"
required: false
type: "string"
- responses:
- "204":
- description: "Successful operation"
- "400":
- description: "Invalid invoice id 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"
- parameters:
- - name: "invoiceId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "customField"
+ format: "date"
+ - name: "pluginProperty"
in: "query"
required: false
type: "array"
items:
type: "string"
- format: "uuid"
collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
@@ -5595,68 +5539,88 @@ paths:
required: false
type: "string"
responses:
- "204":
- description: "Successful operation"
+ "201":
+ description: "Created adjustment Successfully"
+ schema:
+ $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: []
- /1.0/kb/invoices/catalogTranslation/{locale}:
+ /1.0/kb/invoices/byNumber/{invoiceNumber}:
get:
tags:
- "Invoice"
- summary: "Retrieves the catalog translation for the tenant"
+ summary: "Retrieve an invoice by number"
description: ""
- operationId: "getCatalogTranslation"
+ operationId: "getInvoiceByNumber"
produces:
- - "text/plain"
+ - "application/json"
parameters:
- - name: "locale"
+ - name: "invoiceNumber"
in: "path"
required: true
+ type: "integer"
+ pattern: "[0-9]+"
+ format: "int32"
+ - name: "withChildrenItems"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "audit"
+ in: "query"
+ required: false
type: "string"
- pattern: ".*"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
responses:
"200":
description: "successful operation"
schema:
- type: "string"
- "400":
- description: "Invalid locale supplied"
+ $ref: "#/definitions/Invoice"
"404":
- description: "Template not found"
+ description: "Invoice not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- post:
+ /1.0/kb/invoices/{invoiceId}/{invoiceItemId}/cba:
+ delete:
tags:
- "Invoice"
- summary: "Upload the catalog translation for the tenant"
+ summary: "Delete a CBA item"
description: ""
- operationId: "uploadCatalogTranslation"
+ operationId: "deleteCBA"
consumes:
- - "text/plain"
+ - "application/json"
produces:
- - "text/plain"
+ - "application/json"
parameters:
- - name: "locale"
+ - name: "invoiceId"
in: "path"
required: true
type: "string"
- pattern: ".*"
- - in: "body"
- name: "body"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - name: "invoiceItemId"
+ in: "path"
required: true
- schema:
- type: "string"
- - name: "deleteIfExists"
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - name: "accountId"
in: "query"
- required: false
- type: "boolean"
- default: false
+ required: true
+ type: "string"
+ format: "uuid"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -5670,76 +5634,109 @@ paths:
required: false
type: "string"
responses:
- "201":
- description: "Uploaded catalog translation Successfully"
+ "204":
+ description: "Successful operation"
+ "400":
+ description: "Invalid account id, invoice id or invoice item id supplied"
+ "404":
+ description: "Account or invoice not found"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ /1.0/kb/invoices/{invoiceId}/html:
+ get:
+ tags:
+ - "Invoice"
+ summary: "Render an invoice as HTML"
+ description: ""
+ operationId: "getInvoiceAsHTML"
+ produces:
+ - "text/html"
+ parameters:
+ - name: "invoiceId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ responses:
+ "200":
+ description: "successful operation"
schema:
type: "string"
+ "404":
+ description: "Invoice not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoices/{invoiceId}/payments:
- get:
+ /1.0/kb/invoices/migration/{accountId}:
+ post:
tags:
- "Invoice"
- summary: "Retrieve payments associated with an invoice"
+ summary: "Create a migration invoice"
description: ""
- operationId: "getPaymentsForInvoice"
+ operationId: "createMigrationInvoice"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
- - name: "invoiceId"
+ - name: "accountId"
in: "path"
required: true
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "withPluginInfo"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/InvoiceItem"
+ - name: "targetDate"
in: "query"
required: false
- type: "boolean"
- default: false
- - name: "withAttempts"
- in: "query"
+ type: "string"
+ format: "date"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
required: false
- type: "boolean"
- default: false
- - name: "audit"
- in: "query"
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
required: false
type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
responses:
- "200":
- description: "successful operation"
+ "201":
+ description: "Created migration invoice successfully"
schema:
- type: "array"
- items:
- $ref: "#/definitions/InvoicePayment"
+ $ref: "#/definitions/Invoice"
"400":
- description: "Invalid invoice id supplied"
- "404":
- description: "Invoice not found"
+ description: "Invalid account id or target datetime supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ /1.0/kb/invoices/charges/{accountId}:
post:
tags:
- "Invoice"
- summary: "Trigger a payment for invoice"
+ summary: "Create external charge(s)"
description: ""
- operationId: "createInstantPayment"
+ operationId: "createExternalCharges"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- - name: "invoiceId"
+ - name: "accountId"
in: "path"
required: true
type: "string"
@@ -5749,19 +5746,19 @@ paths:
name: "body"
required: true
schema:
- $ref: "#/definitions/InvoicePayment"
- - name: "externalPayment"
+ type: "array"
+ items:
+ $ref: "#/definitions/InvoiceItem"
+ - name: "requestedDate"
in: "query"
required: false
- type: "boolean"
- default: false
- - name: "controlPluginName"
+ type: "string"
+ format: "date"
+ - name: "autoCommit"
in: "query"
required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
+ type: "boolean"
+ default: false
- name: "pluginProperty"
in: "query"
required: false
@@ -5783,36 +5780,31 @@ paths:
type: "string"
responses:
"201":
- description: "Created payment Successfully"
+ description: "Created external charge Successfully"
schema:
- $ref: "#/definitions/InvoicePayment"
- "204":
- description: "Nothing to pay for"
+ type: "array"
+ items:
+ $ref: "#/definitions/InvoiceItem"
"400":
- description: "Invalid account id or invoice id supplied"
+ description: "Invalid account id supplied"
"404":
description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoices/dryRun:
+ /1.0/kb/invoices:
post:
tags:
- "Invoice"
- summary: "Generate a dryRun invoice"
+ summary: "Trigger an invoice generation"
description: ""
- operationId: "generateDryRunInvoice"
+ operationId: "createFutureInvoice"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- - in: "body"
- name: "body"
- required: true
- schema:
- $ref: "#/definitions/InvoiceDryRun"
- name: "accountId"
in: "query"
required: true
@@ -5843,44 +5835,16 @@ paths:
required: false
type: "string"
responses:
- "200":
- description: "successful operation"
+ "201":
+ description: "Created invoice successfully"
schema:
$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/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"
- required: true
- type: "string"
- pattern: ".*"
- responses:
- "200":
- description: "successful operation"
- schema:
- type: "string"
- "404":
- description: "Template not found"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
/1.0/kb/invoices/group:
post:
tags:
@@ -5935,13 +5899,13 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoices/{invoiceId}/auditLogsWithHistory:
+ /1.0/kb/invoices/{invoiceId}/payments:
get:
tags:
- "Invoice"
- summary: "Retrieve invoice audit logs with history by id"
+ summary: "Retrieve payments associated with an invoice"
description: ""
- operationId: "getInvoiceAuditLogsWithHistory"
+ operationId: "getPaymentsForInvoice"
produces:
- "application/json"
parameters:
@@ -5951,43 +5915,36 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ - name: "withPluginInfo"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "withAttempts"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "audit"
+ in: "query"
+ required: false
+ type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
responses:
"200":
description: "successful operation"
schema:
type: "array"
items:
- $ref: "#/definitions/AuditLog"
- "404":
- description: "Invoice not found"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/invoices/translation/{locale}:
- get:
- tags:
- - "Invoice"
- summary: "Retrieves the invoice translation for the tenant"
- description: ""
- operationId: "getInvoiceTranslation"
- produces:
- - "text/plain"
- parameters:
- - name: "locale"
- in: "path"
- required: true
- type: "string"
- pattern: ".*"
- responses:
- "200":
- description: "successful operation"
- schema:
- type: "string"
+ $ref: "#/definitions/InvoicePayment"
"400":
- description: "Invalid locale supplied"
+ description: "Invalid invoice id supplied"
"404":
- description: "Translation not found"
+ description: "Invoice not found"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -5995,29 +5952,44 @@ paths:
post:
tags:
- "Invoice"
- summary: "Upload the invoice translation for the tenant"
+ summary: "Trigger a payment for invoice"
description: ""
- operationId: "uploadInvoiceTranslation"
+ operationId: "createInstantPayment"
consumes:
- - "text/plain"
+ - "application/json"
produces:
- - "text/plain"
+ - "application/json"
parameters:
- - name: "locale"
+ - name: "invoiceId"
in: "path"
required: true
type: "string"
- pattern: ".*"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
- in: "body"
name: "body"
required: true
schema:
- type: "string"
- - name: "deleteIfExists"
+ $ref: "#/definitions/InvoicePayment"
+ - name: "externalPayment"
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
@@ -6032,35 +6004,61 @@ paths:
type: "string"
responses:
"201":
- description: "Uploaded invoice translation Successfully"
+ description: "Created payment Successfully"
schema:
- type: "string"
+ $ref: "#/definitions/InvoicePayment"
+ "204":
+ description: "Nothing to pay for"
+ "400":
+ description: "Invalid account id or invoice id supplied"
+ "404":
+ description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoices/manualPayTemplate:
+ /1.0/kb/invoices/taxes/{accountId}:
post:
tags:
- "Invoice"
- summary: "Upload the manualPay invoice template for the tenant"
+ summary: "Create tax items"
description: ""
- operationId: "uploadInvoiceMPTemplate"
+ operationId: "createTaxItems"
consumes:
- - "text/html"
+ - "application/json"
produces:
- - "text/html"
+ - "application/json"
parameters:
+ - name: "accountId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
- in: "body"
name: "body"
required: true
schema:
- type: "string"
- - name: "deleteIfExists"
+ type: "array"
+ items:
+ $ref: "#/definitions/InvoiceItem"
+ - name: "autoCommit"
in: "query"
required: false
type: "boolean"
default: false
+ - name: "requestedDate"
+ in: "query"
+ required: false
+ type: "string"
+ format: "date"
+ - name: "pluginProperty"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -6074,26 +6072,37 @@ paths:
required: false
type: "string"
responses:
- "200":
- description: "successful operation"
+ "201":
+ description: "Create tax items successfully"
schema:
- type: "string"
+ type: "array"
+ items:
+ $ref: "#/definitions/InvoiceItem"
+ "400":
+ description: "Invalid account id supplied"
+ "404":
+ description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoices:
+ /1.0/kb/invoices/dryRun:
post:
tags:
- "Invoice"
- summary: "Trigger an invoice generation"
+ summary: "Generate a dryRun invoice"
description: ""
- operationId: "createFutureInvoice"
+ operationId: "generateDryRunInvoice"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/InvoiceDryRun"
- name: "accountId"
in: "query"
required: true
@@ -6124,58 +6133,72 @@ paths:
required: false
type: "string"
responses:
- "201":
- description: "Created invoice successfully"
+ "200":
+ description: "successful operation"
schema:
$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/charges/{accountId}:
+ /1.0/kb/invoices/catalogTranslation/{locale}:
+ get:
+ tags:
+ - "Invoice"
+ summary: "Retrieves the catalog translation for the tenant"
+ description: ""
+ operationId: "getCatalogTranslation"
+ produces:
+ - "text/plain"
+ parameters:
+ - name: "locale"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: ".*"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ type: "string"
+ "400":
+ description: "Invalid locale supplied"
+ "404":
+ description: "Template not found"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
post:
tags:
- "Invoice"
- summary: "Create external charge(s)"
+ summary: "Upload the catalog translation for the tenant"
description: ""
- operationId: "createExternalCharges"
+ operationId: "uploadCatalogTranslation"
consumes:
- - "application/json"
+ - "text/plain"
produces:
- - "application/json"
+ - "text/plain"
parameters:
- - name: "accountId"
+ - name: "locale"
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:
- $ref: "#/definitions/InvoiceItem"
- - name: "requestedDate"
- in: "query"
- required: false
- type: "string"
- format: "date"
- - name: "autoCommit"
+ type: "string"
+ - name: "deleteIfExists"
in: "query"
required: false
type: "boolean"
default: false
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -6190,28 +6213,20 @@ paths:
type: "string"
responses:
"201":
- description: "Created external charge Successfully"
+ description: "Uploaded catalog translation Successfully"
schema:
- type: "array"
- items:
- $ref: "#/definitions/InvoiceItem"
- "400":
- description: "Invalid account id supplied"
- "404":
- description: "Account not found"
+ type: "string"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoices/{invoiceId}/commitInvoice:
- put:
+ /1.0/kb/invoices/{invoiceId}/auditLogsWithHistory:
+ get:
tags:
- "Invoice"
- summary: "Perform the invoice status transition from DRAFT to COMMITTED"
+ summary: "Retrieve invoice audit logs with history by id"
description: ""
- operationId: "commitInvoice"
- consumes:
- - "application/json"
+ operationId: "getInvoiceAuditLogsWithHistory"
produces:
- "application/json"
parameters:
@@ -6221,138 +6236,128 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
responses:
- "204":
- description: "Successful operation"
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/AuditLog"
"404":
description: "Invoice not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoices/{invoiceId}/voidInvoice:
- put:
+ /1.0/kb/invoices/byItemId/{itemId}:
+ get:
tags:
- "Invoice"
- summary: "Perform the action of voiding an invoice"
+ summary: "Retrieve an invoice by invoice item id"
description: ""
- operationId: "voidInvoice"
- consumes:
- - "application/json"
+ operationId: "getInvoiceByItemId"
produces:
- "application/json"
parameters:
- - name: "invoiceId"
+ - name: "itemId"
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"
+ - name: "withChildrenItems"
+ in: "query"
required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
+ type: "boolean"
+ default: false
+ - name: "audit"
+ in: "query"
required: false
type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
responses:
- "204":
- description: "Successful operation"
- "400":
- description: "Invalid invoice id supplied"
+ "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/byNumber/{invoiceNumber}:
+ /1.0/kb/invoices/manualPayTemplate/{locale}:
get:
tags:
- "Invoice"
- summary: "Retrieve an invoice by number"
+ summary: "Retrieves the manualPay invoice template for the tenant"
description: ""
- operationId: "getInvoiceByNumber"
+ operationId: "getInvoiceMPTemplate"
produces:
- - "application/json"
+ - "text/html"
parameters:
- - name: "invoiceNumber"
+ - name: "locale"
in: "path"
required: true
- type: "integer"
- pattern: "[0-9]+"
- format: "int32"
- - name: "withChildrenItems"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "audit"
- in: "query"
- required: false
type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
+ pattern: ".*"
responses:
"200":
description: "successful operation"
schema:
- $ref: "#/definitions/Invoice"
+ type: "string"
"404":
- description: "Invoice not found"
+ description: "Template not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoices/{invoiceId}/{invoiceItemId}/cba:
- delete:
+ /1.0/kb/invoices/template:
+ get:
tags:
- "Invoice"
- summary: "Delete a CBA item"
+ summary: "Retrieves the invoice template for the tenant"
description: ""
- operationId: "deleteCBA"
+ operationId: "getInvoiceTemplate"
+ produces:
+ - "text/html"
+ parameters: []
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ type: "string"
+ "404":
+ description: "Template not found"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ post:
+ tags:
+ - "Invoice"
+ summary: "Upload the invoice template for the tenant"
+ description: ""
+ operationId: "uploadInvoiceTemplate"
consumes:
- - "application/json"
+ - "text/html"
produces:
- - "application/json"
+ - "text/html"
parameters:
- - name: "invoiceId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "invoiceItemId"
- in: "path"
+ - in: "body"
+ name: "body"
required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "accountId"
+ schema:
+ type: "string"
+ - name: "deleteIfExists"
in: "query"
- required: true
- type: "string"
- format: "uuid"
+ required: false
+ type: "boolean"
+ default: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -6366,115 +6371,68 @@ paths:
required: false
type: "string"
responses:
- "204":
- description: "Successful operation"
- "400":
- description: "Invalid account id, invoice id or invoice item id supplied"
- "404":
- description: "Account or invoice not found"
+ "201":
+ description: "Uploaded invoice template Successfully"
+ schema:
+ type: "string"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoices/{invoiceId}/html:
+ /1.0/kb/invoices/translation/{locale}:
get:
tags:
- "Invoice"
- summary: "Render an invoice as HTML"
+ summary: "Retrieves the invoice translation for the tenant"
description: ""
- operationId: "getInvoiceAsHTML"
+ operationId: "getInvoiceTranslation"
produces:
- - "text/html"
+ - "text/plain"
parameters:
- - name: "invoiceId"
+ - name: "locale"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
+ pattern: ".*"
responses:
"200":
description: "successful operation"
schema:
type: "string"
+ "400":
+ description: "Invalid locale supplied"
"404":
- description: "Invoice not found"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/invoices/pagination:
- get:
- tags:
- - "Invoice"
- summary: "List invoices"
- description: ""
- operationId: "getInvoices"
- produces:
- - "application/json"
- parameters:
- - name: "offset"
- in: "query"
- required: false
- type: "integer"
- default: 0
- format: "int64"
- - name: "limit"
- in: "query"
- required: false
- type: "integer"
- default: 100
- format: "int64"
- - name: "audit"
- in: "query"
- required: false
- type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
- responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/Invoice"
+ description: "Translation not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoices/migration/{accountId}:
post:
tags:
- "Invoice"
- summary: "Create a migration invoice"
+ summary: "Upload the invoice translation for the tenant"
description: ""
- operationId: "createMigrationInvoice"
+ operationId: "uploadInvoiceTranslation"
consumes:
- - "application/json"
+ - "text/plain"
produces:
- - "application/json"
+ - "text/plain"
parameters:
- - name: "accountId"
+ - name: "locale"
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:
- $ref: "#/definitions/InvoiceItem"
- - name: "targetDate"
+ type: "string"
+ - name: "deleteIfExists"
in: "query"
required: false
- type: "string"
- format: "date"
+ type: "boolean"
+ default: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -6489,42 +6447,39 @@ paths:
type: "string"
responses:
"201":
- description: "Created migration invoice successfully"
+ description: "Uploaded invoice translation Successfully"
schema:
- $ref: "#/definitions/Invoice"
- "400":
- description: "Invalid account id or target datetime supplied"
+ type: "string"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoices/search/{searchKey}:
+ /1.0/kb/invoices/{groupId}/group:
get:
tags:
- "Invoice"
- summary: "Search invoices"
+ summary: "Retrieve a set of invoices by group id"
description: ""
- operationId: "searchInvoices"
+ operationId: "getInvoicesGroup"
produces:
- "application/json"
parameters:
- - name: "searchKey"
+ - name: "groupId"
in: "path"
required: true
type: "string"
- pattern: ".*"
- - name: "offset"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - name: "accountId"
in: "query"
- required: false
- type: "integer"
- default: 0
- format: "int64"
- - name: "limit"
+ required: true
+ type: "string"
+ format: "uuid"
+ - name: "withChildrenItems"
in: "query"
required: false
- type: "integer"
- default: 100
- format: "int64"
+ type: "boolean"
+ default: false
- name: "audit"
in: "query"
required: false
@@ -6541,46 +6496,30 @@ paths:
type: "array"
items:
$ref: "#/definitions/Invoice"
+ "400":
+ description: "Invalid group id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/nodesInfo:
- get:
+ /1.0/kb/invoices/manualPayTemplate:
+ post:
tags:
- - "NodesInfo"
- summary: "Retrieve all the nodes infos"
+ - "Invoice"
+ summary: "Upload the manualPay invoice template for the tenant"
description: ""
- operationId: "getNodesInfo"
+ operationId: "uploadInvoiceMPTemplate"
+ consumes:
+ - "text/html"
produces:
- - "application/json"
- parameters: []
- responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/NodeInfo"
- security:
- - basicAuth: []
- post:
- tags:
- - "NodesInfo"
- summary: "Trigger a node command"
- description: ""
- operationId: "triggerNodeCommand"
- consumes:
- - "application/json"
- produces:
- - "application/json"
+ - "text/html"
parameters:
- in: "body"
name: "body"
required: true
schema:
- $ref: "#/definitions/NodeCommand"
- - name: "localNodeOnly"
+ type: "string"
+ - name: "deleteIfExists"
in: "query"
required: false
type: "boolean"
@@ -6598,45 +6537,54 @@ paths:
required: false
type: "string"
responses:
- "202":
- description: "Successful operation"
- "400":
- description: "Invalid node command supplied"
+ "200":
+ description: "successful operation"
+ schema:
+ type: "string"
security:
- basicAuth: []
- /1.0/kb/overdue/xml:
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ /1.0/kb/nodesInfo:
get:
tags:
- - "Overdue"
- summary: "Retrieve the overdue config as XML"
+ - "NodesInfo"
+ summary: "Retrieve all the nodes infos"
description: ""
- operationId: "getOverdueConfigXml"
+ operationId: "getNodesInfo"
produces:
- - "text/xml"
+ - "application/json"
parameters: []
responses:
"200":
description: "successful operation"
schema:
- type: "string"
+ type: "array"
+ items:
+ $ref: "#/definitions/NodeInfo"
security:
- basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
post:
tags:
- - "Overdue"
- summary: "Upload the full overdue config as XML"
+ - "NodesInfo"
+ summary: "Trigger a node command"
description: ""
- operationId: "uploadOverdueConfigXml"
+ operationId: "triggerNodeCommand"
consumes:
- - "text/xml"
+ - "application/json"
+ produces:
+ - "application/json"
parameters:
- in: "body"
name: "body"
required: true
schema:
- type: "string"
+ $ref: "#/definitions/NodeCommand"
+ - name: "localNodeOnly"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -6650,16 +6598,12 @@ paths:
required: false
type: "string"
responses:
- "201":
- description: "Successfully uploaded overdue config"
- schema:
- type: "string"
+ "202":
+ description: "Successful operation"
"400":
description: "Invalid node command supplied"
security:
- basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
/1.0/kb/overdue:
get:
tags:
@@ -6718,37 +6662,39 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/paymentGateways/hosted/form:
+ /1.0/kb/overdue/xml:
+ get:
+ tags:
+ - "Overdue"
+ summary: "Retrieve the overdue config as XML"
+ description: ""
+ operationId: "getOverdueConfigXml"
+ produces:
+ - "text/xml"
+ parameters: []
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ type: "string"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
post:
tags:
- - "PaymentGateway"
- summary: "Combo API to generate form data to redirect the customer to the gateway"
+ - "Overdue"
+ summary: "Upload the full overdue config as XML"
description: ""
- operationId: "buildComboFormDescriptor"
+ operationId: "uploadOverdueConfigXml"
consumes:
- - "application/json"
- produces:
- - "application/json"
+ - "text/xml"
parameters:
- in: "body"
name: "body"
required: true
schema:
- $ref: "#/definitions/ComboHostedPaymentPage"
- - name: "controlPluginName"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
type: "string"
- collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -6762,12 +6708,12 @@ paths:
required: false
type: "string"
responses:
- "200":
- description: "successful operation"
+ "201":
+ description: "Successfully uploaded overdue config"
schema:
- $ref: "#/definitions/HostedPaymentPageFormDescriptor"
+ type: "string"
"400":
- description: "Invalid data for Account or PaymentMethod"
+ description: "Invalid node command supplied"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -6892,86 +6838,30 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/paymentMethods/{paymentMethodId}:
- get:
+ /1.0/kb/paymentGateways/hosted/form:
+ post:
tags:
- - "PaymentMethod"
- summary: "Retrieve a payment method by id"
+ - "PaymentGateway"
+ summary: "Combo API to generate form data to redirect the customer to the gateway"
description: ""
- operationId: "getPaymentMethod"
+ operationId: "buildComboFormDescriptor"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
- - name: "paymentMethodId"
- in: "path"
+ - in: "body"
+ name: "body"
required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "includedDeleted"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "withPluginInfo"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "pluginProperty"
+ schema:
+ $ref: "#/definitions/ComboHostedPaymentPage"
+ - name: "controlPluginName"
in: "query"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
- - name: "audit"
- in: "query"
- required: false
- type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
- responses:
- "200":
- description: "successful operation"
- schema:
- $ref: "#/definitions/PaymentMethod"
- "400":
- description: "Invalid paymentMethodId supplied"
- "404":
- description: "Account or payment method not found"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- delete:
- tags:
- - "PaymentMethod"
- summary: "Delete a payment method"
- description: ""
- operationId: "deletePaymentMethod"
- produces:
- - "application/json"
- parameters:
- - name: "paymentMethodId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "deleteDefaultPmWithAutoPayOff"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "forceDefaultPmDeletion"
- in: "query"
- required: false
- type: "boolean"
- default: false
- name: "pluginProperty"
in: "query"
required: false
@@ -6991,64 +6881,13 @@ paths:
in: "header"
required: false
type: "string"
- responses:
- "204":
- description: "Successful operation"
- "400":
- description: "Invalid paymentMethodId supplied"
- "404":
- description: "Account or payment method not found"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/paymentMethods:
- get:
- tags:
- - "PaymentMethod"
- summary: "Retrieve a payment method by external key"
- description: ""
- operationId: "getPaymentMethodByKey"
- produces:
- - "application/json"
- parameters:
- - name: "externalKey"
- in: "query"
- required: true
- type: "string"
- - name: "includedDeleted"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "withPluginInfo"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "audit"
- in: "query"
- required: false
- type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
responses:
"200":
description: "successful operation"
schema:
- $ref: "#/definitions/PaymentMethod"
- "404":
- description: "Account or payment method not found"
+ $ref: "#/definitions/HostedPaymentPageFormDescriptor"
+ "400":
+ description: "Invalid data for Account or PaymentMethod"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -7231,35 +7070,6 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /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"
- 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/paymentMethods/pagination:
get:
tags:
@@ -7381,25 +7191,87 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/combo:
- post:
+ /1.0/kb/paymentMethods/{paymentMethodId}:
+ get:
tags:
- - "Payment"
- summary: "Combo api to create a new payment transaction on a existing (or not)\
- \ account "
+ - "PaymentMethod"
+ summary: "Retrieve a payment method by id"
description: ""
- operationId: "createComboPayment"
- consumes:
+ operationId: "getPaymentMethod"
+ produces:
- "application/json"
+ parameters:
+ - name: "paymentMethodId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - name: "includedDeleted"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "withPluginInfo"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "pluginProperty"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ - name: "audit"
+ in: "query"
+ required: false
+ type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ $ref: "#/definitions/PaymentMethod"
+ "400":
+ description: "Invalid paymentMethodId supplied"
+ "404":
+ description: "Account or payment method not found"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ delete:
+ tags:
+ - "PaymentMethod"
+ summary: "Delete a payment method"
+ description: ""
+ operationId: "deletePaymentMethod"
produces:
- "application/json"
parameters:
- - in: "body"
- name: "body"
+ - name: "paymentMethodId"
+ in: "path"
required: true
- schema:
- $ref: "#/definitions/ComboPaymentTransaction"
- - name: "controlPluginName"
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - name: "deleteDefaultPmWithAutoPayOff"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "forceDefaultPmDeletion"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "pluginProperty"
in: "query"
required: false
type: "array"
@@ -7419,22 +7291,92 @@ paths:
required: false
type: "string"
responses:
- "201":
- description: "Payment transaction created successfully"
- schema:
- $ref: "#/definitions/Payment"
+ "204":
+ description: "Successful operation"
"400":
- description: "Invalid data for Account or PaymentMethod"
- "402":
- description: "Transaction declined by gateway"
- "422":
- description: "Payment is aborted by a control plugin"
- "502":
- description: "Failed to submit payment transaction"
- "503":
- description: "Payment in unknown status, failed to receive gateway response"
- "504":
- description: "Payment operation timeout"
+ description: "Invalid paymentMethodId supplied"
+ "404":
+ description: "Account or payment method not found"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ /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"
+ 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/paymentMethods:
+ get:
+ tags:
+ - "PaymentMethod"
+ summary: "Retrieve a payment method by external key"
+ description: ""
+ operationId: "getPaymentMethodByKey"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "externalKey"
+ in: "query"
+ required: true
+ type: "string"
+ - name: "includedDeleted"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "withPluginInfo"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "pluginProperty"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ - name: "audit"
+ in: "query"
+ required: false
+ type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ $ref: "#/definitions/PaymentMethod"
+ "404":
+ description: "Account or payment method not found"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -7580,13 +7522,13 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/{paymentId}:
+ /1.0/kb/payments/{paymentId}/customFields:
get:
tags:
- "Payment"
- summary: "Retrieve a payment by id"
+ summary: "Retrieve payment custom fields"
description: ""
- operationId: "getPayment"
+ operationId: "getPaymentCustomFields"
produces:
- "application/json"
parameters:
@@ -7596,23 +7538,6 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "withPluginInfo"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "withAttempts"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- name: "audit"
in: "query"
required: false
@@ -7626,11 +7551,11 @@ paths:
"200":
description: "successful operation"
schema:
- $ref: "#/definitions/Payment"
+ type: "array"
+ items:
+ $ref: "#/definitions/CustomField"
"400":
- description: "Invalid paymentId supplied"
- "404":
- description: "Payment not found"
+ description: "Invalid payment id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -7638,9 +7563,9 @@ paths:
post:
tags:
- "Payment"
- summary: "Capture an existing authorization"
+ summary: "Add custom fields to payment"
description: ""
- operationId: "captureAuthorization"
+ operationId: "createPaymentCustomFields"
consumes:
- "application/json"
produces:
@@ -7656,21 +7581,9 @@ paths:
name: "body"
required: true
schema:
- $ref: "#/definitions/PaymentTransaction"
- - name: "controlPluginName"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
+ type: "array"
+ items:
+ $ref: "#/definitions/CustomField"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -7685,23 +7598,13 @@ paths:
type: "string"
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: []
@@ -7709,9 +7612,9 @@ paths:
put:
tags:
- "Payment"
- summary: "Complete an existing transaction"
+ summary: "Modify custom fields to payment"
description: ""
- operationId: "completeTransaction"
+ operationId: "modifyPaymentCustomFields"
consumes:
- "application/json"
produces:
@@ -7727,20 +7630,54 @@ paths:
name: "body"
required: true
schema:
- $ref: "#/definitions/PaymentTransaction"
- - name: "controlPluginName"
- in: "query"
+ 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: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "pluginProperty"
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
+ required: false
+ type: "string"
+ responses:
+ "204":
+ description: "Successful operation"
+ "400":
+ description: "Invalid payment id supplied"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ delete:
+ tags:
+ - "Payment"
+ summary: "Remove custom fields from payment payment"
+ description: ""
+ operationId: "deletePaymentCustomFields"
+ consumes:
+ - "application/json"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "paymentId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - name: "customField"
in: "query"
required: false
type: "array"
items:
type: "string"
+ format: "uuid"
collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
@@ -7757,30 +7694,73 @@ paths:
responses:
"204":
description: "Successful operation"
+ "400":
+ description: "Invalid payment id supplied"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ /1.0/kb/payments/{paymentId}:
+ get:
+ tags:
+ - "Payment"
+ summary: "Retrieve a payment by id"
+ description: ""
+ operationId: "getPayment"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "paymentId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - name: "withPluginInfo"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "withAttempts"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "pluginProperty"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ - name: "audit"
+ in: "query"
+ required: false
+ type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ $ref: "#/definitions/Payment"
"400":
description: "Invalid paymentId supplied"
"404":
- description: "Account or payment not found"
- "402":
- description: "Transaction declined by gateway"
- "422":
- description: "Payment is aborted by a control plugin"
- "502":
- description: "Failed to submit payment transaction"
- "503":
- description: "Payment in unknown status, failed to receive gateway response"
- "504":
- description: "Payment operation timeout"
+ description: "Payment not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- delete:
+ post:
tags:
- "Payment"
- summary: "Void an existing payment"
+ summary: "Capture an existing authorization"
description: ""
- operationId: "voidPayment"
+ operationId: "captureAuthorization"
consumes:
- "application/json"
produces:
@@ -7824,8 +7804,10 @@ paths:
required: false
type: "string"
responses:
- "204":
- description: "Successful operation"
+ "201":
+ description: "Payment transaction created successfully"
+ schema:
+ $ref: "#/definitions/Payment"
"400":
description: "Invalid paymentId supplied"
"404":
@@ -7844,13 +7826,12 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/{paymentId}/chargebacks:
- post:
+ put:
tags:
- "Payment"
- summary: "Record a chargeback"
+ summary: "Complete an existing transaction"
description: ""
- operationId: "chargebackPayment"
+ operationId: "completeTransaction"
consumes:
- "application/json"
produces:
@@ -7894,10 +7875,8 @@ paths:
required: false
type: "string"
responses:
- "201":
- description: "Payment transaction created successfully"
- schema:
- $ref: "#/definitions/Payment"
+ "204":
+ description: "Successful operation"
"400":
description: "Invalid paymentId supplied"
"404":
@@ -7916,13 +7895,12 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/{paymentId}/refunds:
- post:
+ delete:
tags:
- "Payment"
- summary: "Refund an existing payment"
+ summary: "Void an existing payment"
description: ""
- operationId: "refundPayment"
+ operationId: "voidPayment"
consumes:
- "application/json"
produces:
@@ -7966,10 +7944,8 @@ paths:
required: false
type: "string"
responses:
- "201":
- description: "Payment transaction created successfully"
- schema:
- $ref: "#/definitions/Payment"
+ "204":
+ description: "Successful operation"
"400":
description: "Invalid paymentId supplied"
"404":
@@ -8224,30 +8200,42 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/chargebacks:
- post:
+ /1.0/kb/payments/pagination:
+ get:
tags:
- "Payment"
- summary: "Record a chargeback"
+ summary: "Get payments"
description: ""
- operationId: "chargebackPaymentByExternalKey"
- consumes:
- - "application/json"
+ operationId: "getPayments"
produces:
- "application/json"
parameters:
- - in: "body"
- name: "body"
- required: true
- schema:
- $ref: "#/definitions/PaymentTransaction"
- - name: "controlPluginName"
+ - name: "offset"
in: "query"
required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
+ type: "integer"
+ default: 0
+ format: "int64"
+ - name: "limit"
+ in: "query"
+ required: false
+ type: "integer"
+ default: 100
+ format: "int64"
+ - name: "pluginName"
+ in: "query"
+ required: false
+ type: "string"
+ - name: "withPluginInfo"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "withAttempts"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
- name: "pluginProperty"
in: "query"
required: false
@@ -8255,46 +8243,177 @@ paths:
items:
type: "string"
collectionFormat: "multi"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
+ - name: "audit"
+ in: "query"
required: false
type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
responses:
- "201":
- description: "Payment transaction created successfully"
+ "200":
+ description: "successful operation"
schema:
- $ref: "#/definitions/Payment"
- "404":
- description: "Account or payment not found"
- "402":
- description: "Transaction declined by gateway"
- "422":
- description: "Payment is aborted by a control plugin"
- "502":
- description: "Failed to submit payment transaction"
- "503":
- description: "Payment in unknown status, failed to receive gateway response"
- "504":
- description: "Payment operation timeout"
+ type: "array"
+ items:
+ $ref: "#/definitions/Payment"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/{paymentId}/chargebackReversals:
+ /1.0/kb/payments/search/{searchKey}:
+ get:
+ tags:
+ - "Payment"
+ summary: "Search payments"
+ description: ""
+ operationId: "searchPayments"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "searchKey"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: ".*"
+ - name: "offset"
+ in: "query"
+ required: false
+ type: "integer"
+ default: 0
+ format: "int64"
+ - name: "limit"
+ in: "query"
+ required: false
+ type: "integer"
+ default: 100
+ format: "int64"
+ - name: "withPluginInfo"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "withAttempts"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "pluginName"
+ in: "query"
+ required: false
+ type: "string"
+ - name: "pluginProperty"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ - name: "audit"
+ in: "query"
+ required: false
+ type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/Payment"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ /1.0/kb/payments/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 reversal"
+ summary: "Record a chargeback"
description: ""
- operationId: "chargebackReversalPayment"
+ operationId: "chargebackPayment"
consumes:
- "application/json"
produces:
@@ -8360,47 +8479,88 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/{paymentId}/auditLogsWithHistory:
- get:
+ /1.0/kb/payments/chargebacks:
+ post:
tags:
- "Payment"
- summary: "Retrieve payment audit logs with history by id"
+ summary: "Record a chargeback"
description: ""
- operationId: "getPaymentAuditLogsWithHistory"
+ operationId: "chargebackPaymentByExternalKey"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
- - name: "paymentId"
- in: "path"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/PaymentTransaction"
+ - name: "controlPluginName"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ - name: "pluginProperty"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ required: false
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
+ required: false
+ type: "string"
responses:
- "200":
- description: "successful operation"
+ "201":
+ description: "Payment transaction created successfully"
schema:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
+ $ref: "#/definitions/Payment"
"404":
- description: "Account not found"
+ description: "Account or payment not found"
+ "402":
+ description: "Transaction declined by gateway"
+ "422":
+ description: "Payment is aborted by a control plugin"
+ "502":
+ description: "Failed to submit payment transaction"
+ "503":
+ description: "Payment in unknown status, failed to receive gateway response"
+ "504":
+ description: "Payment operation timeout"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/refunds:
+ /1.0/kb/payments/{paymentId}/chargebackReversals:
post:
tags:
- "Payment"
- summary: "Refund an existing payment"
+ summary: "Record a chargeback reversal"
description: ""
- operationId: "refundPaymentByExternalKey"
+ operationId: "chargebackReversalPayment"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
+ - name: "paymentId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
- in: "body"
name: "body"
required: true
@@ -8437,6 +8597,8 @@ paths:
description: "Payment transaction created successfully"
schema:
$ref: "#/definitions/Payment"
+ "400":
+ description: "Invalid paymentId supplied"
"404":
description: "Account or payment not found"
"402":
@@ -8453,68 +8615,37 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/{paymentId}/customFields:
- get:
+ /1.0/kb/payments/chargebackReversals:
+ post:
tags:
- "Payment"
- summary: "Retrieve payment custom fields"
+ summary: "Record a chargeback reversal"
description: ""
- operationId: "getPaymentCustomFields"
+ operationId: "chargebackReversalPaymentByExternalKey"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
- - name: "paymentId"
- in: "path"
+ - in: "body"
+ name: "body"
required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "audit"
+ schema:
+ $ref: "#/definitions/PaymentTransaction"
+ - name: "controlPluginName"
in: "query"
required: false
- type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
- responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/CustomField"
- "400":
- description: "Invalid payment id supplied"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- post:
- tags:
- - "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"
+ 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
@@ -8529,86 +8660,49 @@ paths:
type: "string"
responses:
"201":
- description: "Custom field created successfully"
+ description: "Payment transaction created successfully"
schema:
- type: "array"
- items:
- $ref: "#/definitions/CustomField"
- "400":
- description: "Invalid payment id supplied"
+ $ref: "#/definitions/Payment"
+ "404":
+ description: "Account or payment not found"
+ "402":
+ description: "Transaction declined by gateway"
+ "422":
+ description: "Payment is aborted by a control plugin"
+ "502":
+ description: "Failed to submit payment transaction"
+ "503":
+ description: "Payment in unknown status, failed to receive gateway response"
+ "504":
+ description: "Payment operation timeout"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- put:
+ /1.0/kb/payments/combo:
+ post:
tags:
- "Payment"
- summary: "Modify custom fields to payment"
+ summary: "Combo api to create a new payment transaction on a existing (or not)\
+ \ account "
description: ""
- operationId: "modifyPaymentCustomFields"
+ operationId: "createComboPayment"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- - name: "paymentId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- in: "body"
name: "body"
required: true
schema:
- type: "array"
- items:
- $ref: "#/definitions/CustomField"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
- responses:
- "204":
- description: "Successful operation"
- "400":
- description: "Invalid payment id supplied"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- delete:
- tags:
- - "Payment"
- summary: "Remove custom fields from payment payment"
- description: ""
- operationId: "deletePaymentCustomFields"
- consumes:
- - "application/json"
- produces:
- - "application/json"
- parameters:
- - name: "paymentId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "customField"
+ $ref: "#/definitions/ComboPaymentTransaction"
+ - name: "controlPluginName"
in: "query"
required: false
type: "array"
items:
type: "string"
- format: "uuid"
collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
@@ -8623,101 +8717,66 @@ paths:
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/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"
+ "201":
+ description: "Payment transaction created successfully"
+ schema:
+ $ref: "#/definitions/Payment"
"400":
- description: "Invalid paymentTransactionExternalKey supplied"
+ 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/{paymentTransactionId}/cancelScheduledPaymentTransaction:
- delete:
+ /1.0/kb/payments/attempts/{paymentAttemptId}/auditLogsWithHistory:
+ get:
tags:
- "Payment"
- summary: "Cancels a scheduled payment attempt retry"
+ summary: "Retrieve payment attempt audit logs with history by id"
description: ""
- operationId: "cancelScheduledPaymentTransactionById"
- consumes:
- - "application/json"
+ operationId: "getPaymentAttemptAuditLogsWithHistory"
produces:
- "application/json"
parameters:
- - name: "paymentTransactionId"
+ - name: "paymentAttemptId"
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"
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/AuditLog"
+ "404":
+ description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/attempts/{paymentAttemptId}/auditLogsWithHistory:
+ /1.0/kb/payments/{paymentId}/auditLogsWithHistory:
get:
tags:
- "Payment"
- summary: "Retrieve payment attempt audit logs with history by id"
+ summary: "Retrieve payment audit logs with history by id"
description: ""
- operationId: "getPaymentAttemptAuditLogsWithHistory"
+ operationId: "getPaymentAuditLogsWithHistory"
produces:
- "application/json"
parameters:
- - name: "paymentAttemptId"
+ - name: "paymentId"
in: "path"
required: true
type: "string"
@@ -8736,18 +8795,24 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/chargebackReversals:
+ /1.0/kb/payments/{paymentId}/refunds:
post:
tags:
- "Payment"
- summary: "Record a chargeback reversal"
+ summary: "Refund an existing payment"
description: ""
- operationId: "chargebackReversalPaymentByExternalKey"
+ operationId: "refundPayment"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
+ - name: "paymentId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
- in: "body"
name: "body"
required: true
@@ -8784,6 +8849,8 @@ paths:
description: "Payment transaction created successfully"
schema:
$ref: "#/definitions/Payment"
+ "400":
+ description: "Invalid paymentId supplied"
"404":
description: "Account or payment not found"
"402":
@@ -8800,110 +8867,30 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/pagination:
- get:
+ /1.0/kb/payments/refunds:
+ post:
tags:
- "Payment"
- summary: "Get payments"
+ summary: "Refund an existing payment"
description: ""
- operationId: "getPayments"
+ operationId: "refundPaymentByExternalKey"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
- - name: "offset"
- in: "query"
- required: false
- type: "integer"
- default: 0
- format: "int64"
- - name: "limit"
- in: "query"
- required: false
- type: "integer"
- default: 100
- format: "int64"
- - name: "pluginName"
- in: "query"
- required: false
- type: "string"
- - name: "withPluginInfo"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "withAttempts"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "pluginProperty"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/PaymentTransaction"
+ - name: "controlPluginName"
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/search/{searchKey}:
- get:
- tags:
- - "Payment"
- summary: "Search payments"
- description: ""
- operationId: "searchPayments"
- produces:
- - "application/json"
- parameters:
- - name: "searchKey"
- in: "path"
- required: true
- type: "string"
- pattern: ".*"
- - name: "offset"
- in: "query"
- required: false
- type: "integer"
- default: 0
- format: "int64"
- - name: "limit"
- in: "query"
- required: false
- type: "integer"
- default: 100
- format: "int64"
- - name: "withPluginInfo"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "withAttempts"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "pluginName"
- in: "query"
- required: false
- type: "string"
- name: "pluginProperty"
in: "query"
required: false
@@ -8911,22 +8898,35 @@ paths:
items:
type: "string"
collectionFormat: "multi"
- - name: "audit"
- in: "query"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ required: false
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
required: false
type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
responses:
- "200":
- description: "successful operation"
+ "201":
+ description: "Payment transaction created successfully"
schema:
- type: "array"
- items:
- $ref: "#/definitions/Payment"
+ $ref: "#/definitions/Payment"
+ "404":
+ description: "Account or payment not found"
+ "402":
+ description: "Transaction declined by gateway"
+ "422":
+ description: "Payment is aborted by a control plugin"
+ "502":
+ description: "Failed to submit payment transaction"
+ "503":
+ description: "Payment in unknown status, failed to receive gateway response"
+ "504":
+ description: "Payment operation timeout"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -8952,46 +8952,37 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/security/users/{username}/roles:
+ /1.0/kb/security/permissions:
get:
tags:
- "Security"
- summary: "Get roles associated to a user"
+ summary: "List user permissions"
description: ""
- operationId: "getUserRoles"
+ operationId: "getCurrentUserPermissions"
produces:
- "application/json"
- parameters:
- - name: "username"
- in: "path"
- required: true
- type: "string"
- pattern: ".*"
+ parameters: []
responses:
"200":
description: "successful operation"
schema:
- $ref: "#/definitions/UserRoles"
- "404":
- description: "The user does not exist or has been inactivated"
+ type: "array"
+ items:
+ type: "string"
security:
- basicAuth: []
- put:
+ /1.0/kb/security/users:
+ post:
tags:
- "Security"
- summary: "Update roles associated to a user"
+ summary: "Add a new user with roles (to make api requests)"
description: ""
- operationId: "updateUserRoles"
+ operationId: "addUserRoles"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- - name: "username"
- in: "path"
- required: true
- type: "string"
- pattern: ".*"
- in: "body"
name: "body"
required: true
@@ -9010,27 +9001,34 @@ paths:
required: false
type: "string"
responses:
- "204":
- description: "Successful operation"
+ "201":
+ description: "User role created successfully"
+ schema:
+ $ref: "#/definitions/UserRoles"
security:
- basicAuth: []
- /1.0/kb/security/roles:
- post:
+ /1.0/kb/security/users/{username}/password:
+ put:
tags:
- "Security"
- summary: "Add a new role definition)"
+ summary: "Update a user password"
description: ""
- operationId: "addRoleDefinition"
+ operationId: "updateUserPassword"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
+ - name: "username"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: ".*"
- in: "body"
name: "body"
required: true
schema:
- $ref: "#/definitions/RoleDefinition"
+ $ref: "#/definitions/UserRoles"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -9044,28 +9042,55 @@ paths:
required: false
type: "string"
responses:
- "201":
- description: "Role definition created successfully"
+ "204":
+ description: "Successful operation"
+ security:
+ - basicAuth: []
+ /1.0/kb/security/users/{username}/roles:
+ get:
+ tags:
+ - "Security"
+ summary: "Get roles associated to a user"
+ description: ""
+ operationId: "getUserRoles"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "username"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: ".*"
+ responses:
+ "200":
+ description: "successful operation"
schema:
- $ref: "#/definitions/RoleDefinition"
+ $ref: "#/definitions/UserRoles"
+ "404":
+ description: "The user does not exist or has been inactivated"
security:
- basicAuth: []
put:
tags:
- "Security"
- summary: "Update a new role definition)"
+ summary: "Update roles associated to a user"
description: ""
- operationId: "updateRoleDefinition"
+ operationId: "updateUserRoles"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
+ - name: "username"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: ".*"
- in: "body"
name: "body"
required: true
schema:
- $ref: "#/definitions/RoleDefinition"
+ $ref: "#/definitions/UserRoles"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -9117,13 +9142,13 @@ paths:
description: "Successful operation"
security:
- basicAuth: []
- /1.0/kb/security/users:
+ /1.0/kb/security/roles:
post:
tags:
- "Security"
- summary: "Add a new user with roles (to make api requests)"
+ summary: "Add a new role definition)"
description: ""
- operationId: "addUserRoles"
+ operationId: "addRoleDefinition"
consumes:
- "application/json"
produces:
@@ -9133,7 +9158,7 @@ paths:
name: "body"
required: true
schema:
- $ref: "#/definitions/UserRoles"
+ $ref: "#/definitions/RoleDefinition"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -9148,55 +9173,27 @@ paths:
type: "string"
responses:
"201":
- description: "User role created successfully"
+ description: "Role definition created successfully"
schema:
- $ref: "#/definitions/UserRoles"
+ $ref: "#/definitions/RoleDefinition"
security:
- basicAuth: []
- /1.0/kb/security/roles/{role}:
- get:
+ put:
tags:
- "Security"
- summary: "Get role definition"
+ summary: "Update a new role definition)"
description: ""
- operationId: "getRoleDefinition"
+ operationId: "updateRoleDefinition"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
- - name: "role"
- in: "path"
- required: true
- type: "string"
- pattern: ".*"
- responses:
- "200":
- description: "successful operation"
- schema:
- $ref: "#/definitions/RoleDefinition"
- security:
- - basicAuth: []
- /1.0/kb/security/users/{username}/password:
- put:
- tags:
- - "Security"
- summary: "Update a user password"
- description: ""
- operationId: "updateUserPassword"
- consumes:
- - "application/json"
- produces:
- - "application/json"
- parameters:
- - name: "username"
- in: "path"
- required: true
- type: "string"
- pattern: ".*"
- - in: "body"
- name: "body"
+ - in: "body"
+ name: "body"
required: true
schema:
- $ref: "#/definitions/UserRoles"
+ $ref: "#/definitions/RoleDefinition"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -9214,30 +9211,35 @@ paths:
description: "Successful operation"
security:
- basicAuth: []
- /1.0/kb/security/subject:
+ /1.0/kb/security/roles/{role}:
get:
tags:
- "Security"
- summary: "Get user information"
+ summary: "Get role definition"
description: ""
- operationId: "getCurrentUserSubject"
+ operationId: "getRoleDefinition"
produces:
- "application/json"
- parameters: []
+ parameters:
+ - name: "role"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: ".*"
responses:
"200":
description: "successful operation"
schema:
- $ref: "#/definitions/Subject"
+ $ref: "#/definitions/RoleDefinition"
security:
- basicAuth: []
- /1.0/kb/security/permissions:
+ /1.0/kb/security/subject:
get:
tags:
- "Security"
- summary: "List user permissions"
+ summary: "Get user information"
description: ""
- operationId: "getCurrentUserPermissions"
+ operationId: "getCurrentUserSubject"
produces:
- "application/json"
parameters: []
@@ -9245,25 +9247,30 @@ paths:
"200":
description: "successful operation"
schema:
- type: "array"
- items:
- type: "string"
+ $ref: "#/definitions/Subject"
security:
- basicAuth: []
- /1.0/kb/subscriptions:
+ /1.0/kb/subscriptions/{subscriptionId}/tags:
get:
tags:
- "Subscription"
- summary: "Retrieve a subscription by external key"
+ summary: "Retrieve subscription tags"
description: ""
- operationId: "getSubscriptionByKey"
+ operationId: "getSubscriptionTags"
produces:
- "application/json"
parameters:
- - name: "externalKey"
- in: "query"
+ - name: "subscriptionId"
+ in: "path"
required: true
type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - name: "includedDeleted"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
- name: "audit"
in: "query"
required: false
@@ -9277,7 +9284,11 @@ paths:
"200":
description: "successful operation"
schema:
- $ref: "#/definitions/Subscription"
+ type: "array"
+ items:
+ $ref: "#/definitions/Tag"
+ "400":
+ description: "Invalid subscription id supplied"
"404":
description: "Subscription not found"
security:
@@ -9287,61 +9298,71 @@ paths:
post:
tags:
- "Subscription"
- summary: "Create a subscription"
- description: ""
- operationId: "createSubscription"
+ operationId: "createSubscriptionTags"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
+ - name: "subscriptionId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
- in: "body"
name: "body"
required: true
schema:
- $ref: "#/definitions/Subscription"
- - name: "entitlementDate"
- in: "query"
- required: false
+ type: "array"
+ items:
+ type: "string"
+ format: "uuid"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
type: "string"
- format: "date"
- - name: "billingDate"
- in: "query"
+ - name: "X-Killbill-Reason"
+ in: "header"
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"
+ - name: "X-Killbill-Comment"
+ in: "header"
required: false
- type: "integer"
- default: 3
- format: "int64"
- - name: "pluginProperty"
+ type: "string"
+ responses:
+ "201":
+ description: "Tag created successfully"
+ "400":
+ description: "Invalid subscription id supplied"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ delete:
+ tags:
+ - "Subscription"
+ summary: "Remove tags from subscription"
+ description: ""
+ operationId: "deleteSubscriptionTags"
+ consumes:
+ - "application/json"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "subscriptionId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - name: "tagDef"
in: "query"
required: false
type: "array"
items:
type: "string"
+ format: "uuid"
collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
@@ -9356,21 +9377,21 @@ paths:
required: false
type: "string"
responses:
- "201":
- description: "Subscription created successfully"
- schema:
- $ref: "#/definitions/Subscription"
+ "204":
+ description: "Successful operation"
+ "400":
+ description: "Invalid subscription id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/subscriptions/{subscriptionId}:
+ /1.0/kb/subscriptions/{subscriptionId}/customFields:
get:
tags:
- "Subscription"
- summary: "Retrieve a subscription by id"
+ summary: "Retrieve subscription custom fields"
description: ""
- operationId: "getSubscription"
+ operationId: "getSubscriptionCustomFields"
produces:
- "application/json"
parameters:
@@ -9393,21 +9414,21 @@ paths:
"200":
description: "successful operation"
schema:
- $ref: "#/definitions/Subscription"
+ type: "array"
+ items:
+ $ref: "#/definitions/CustomField"
"400":
description: "Invalid subscription id supplied"
- "404":
- description: "Subscription not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- put:
+ post:
tags:
- "Subscription"
- summary: "Change entitlement plan"
+ summary: "Add custom fields to subscription"
description: ""
- operationId: "changeSubscriptionPlan"
+ operationId: "createSubscriptionCustomFields"
consumes:
- "application/json"
produces:
@@ -9423,39 +9444,9 @@ paths:
name: "body"
required: true
schema:
- $ref: "#/definitions/Subscription"
- - name: "requestedDate"
- in: "query"
- required: false
- type: "string"
- format: "date"
- - name: "callCompletion"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "callTimeoutSec"
- in: "query"
- required: false
- type: "integer"
- default: 3
- format: "int64"
- - name: "billingPolicy"
- in: "query"
- required: false
- type: "string"
- enum:
- - "START_OF_TERM"
- - "END_OF_TERM"
- - "IMMEDIATE"
- - "ILLEGAL"
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
+ type: "array"
+ items:
+ $ref: "#/definitions/CustomField"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -9469,22 +9460,22 @@ paths:
required: false
type: "string"
responses:
- "204":
- description: "Successful operation"
+ "201":
+ description: "Custom field created successfully"
"400":
description: "Invalid subscription id supplied"
- "404":
- description: "Entitlement not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- delete:
+ put:
tags:
- "Subscription"
- summary: "Cancel an entitlement plan"
+ summary: "Modify custom fields to subscription"
description: ""
- operationId: "cancelSubscriptionPlan"
+ operationId: "modifySubscriptionCustomFields"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
@@ -9494,49 +9485,58 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "requestedDate"
- in: "query"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/CustomField"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
required: false
type: "string"
- format: "date"
- - name: "callCompletion"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "callTimeoutSec"
- in: "query"
- required: false
- type: "integer"
- default: 5
- format: "int64"
- - name: "entitlementPolicy"
- in: "query"
+ - name: "X-Killbill-Comment"
+ in: "header"
required: false
type: "string"
- enum:
- - "IMMEDIATE"
- - "END_OF_TERM"
- - name: "billingPolicy"
- in: "query"
- 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"
+ required: true
type: "string"
- enum:
- - "START_OF_TERM"
- - "END_OF_TERM"
- - "IMMEDIATE"
- - "ILLEGAL"
- - name: "useRequestedDateForBilling"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "pluginProperty"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - name: "customField"
in: "query"
required: false
type: "array"
items:
type: "string"
+ format: "uuid"
collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
@@ -9555,20 +9555,18 @@ paths:
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}/uncancel:
- put:
+ /1.0/kb/subscriptions/{subscriptionId}/block:
+ post:
tags:
- "Subscription"
- summary: "Un-cancel an entitlement"
+ summary: "Block a subscription"
description: ""
- operationId: "uncancelSubscriptionPlan"
- produces:
+ operationId: "addSubscriptionBlockingState"
+ consumes:
- "application/json"
parameters:
- name: "subscriptionId"
@@ -9577,6 +9575,16 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/BlockingState"
+ - name: "requestedDate"
+ in: "query"
+ required: false
+ type: "string"
+ format: "date"
- name: "pluginProperty"
in: "query"
required: false
@@ -9597,23 +9605,27 @@ paths:
required: false
type: "string"
responses:
- "204":
- description: "Successful operation"
+ "201":
+ description: "Blocking state created successfully"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/BlockingState"
"400":
description: "Invalid subscription id supplied"
"404":
- description: "Entitlement not found"
+ description: "Subscription not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/subscriptions/{subscriptionId}/undoChangePlan:
- put:
+ /1.0/kb/subscriptions/{subscriptionId}:
+ get:
tags:
- "Subscription"
- summary: "Undo a pending change plan on an entitlement"
+ summary: "Retrieve a subscription by id"
description: ""
- operationId: "undoChangeSubscriptionPlan"
+ operationId: "getSubscription"
produces:
- "application/json"
parameters:
@@ -9623,80 +9635,55 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - 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:
- "204":
- description: "Successful operation"
+ "200":
+ description: "successful operation"
+ schema:
+ $ref: "#/definitions/Subscription"
"400":
description: "Invalid subscription id supplied"
"404":
- description: "Entitlement not found"
+ description: "Subscription not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/subscriptions/createSubscriptionsWithAddOns:
- post:
+ put:
tags:
- "Subscription"
- summary: "Create multiple entitlements with addOn products"
+ summary: "Change entitlement plan"
description: ""
- operationId: "createSubscriptionsWithAddOns"
+ 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"
- 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"
+ $ref: "#/definitions/Subscription"
+ - name: "requestedDate"
in: "query"
required: false
type: "string"
format: "date"
- - name: "renameKeyIfExistsAndUnused"
- in: "query"
- required: false
- type: "boolean"
- default: true
- - name: "migrated"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "skipResponse"
- in: "query"
- required: false
- type: "boolean"
- default: false
- name: "callCompletion"
in: "query"
required: false
@@ -9708,6 +9695,15 @@ paths:
type: "integer"
default: 3
format: "int64"
+ - name: "billingPolicy"
+ in: "query"
+ required: false
+ type: "string"
+ enum:
+ - "START_OF_TERM"
+ - "END_OF_TERM"
+ - "IMMEDIATE"
+ - "ILLEGAL"
- name: "pluginProperty"
in: "query"
required: false
@@ -9728,25 +9724,22 @@ paths:
required: false
type: "string"
responses:
- "201":
- description: "Subscriptions created successfully"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/Bundle"
+ "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:
+ delete:
tags:
- "Subscription"
- summary: "Update the BCD associated to a subscription"
+ summary: "Cancel an entitlement plan"
description: ""
- operationId: "updateSubscriptionBCD"
- consumes:
- - "application/json"
+ operationId: "cancelSubscriptionPlan"
produces:
- "application/json"
parameters:
@@ -9756,21 +9749,50 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- $ref: "#/definitions/Subscription"
- - name: "effectiveFromDate"
+ - name: "requestedDate"
in: "query"
required: false
type: "string"
format: "date"
- - name: "forceNewBcdWithPastEffectiveDate"
+ - name: "callCompletion"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "callTimeoutSec"
+ in: "query"
+ required: false
+ type: "integer"
+ default: 5
+ format: "int64"
+ - name: "entitlementPolicy"
+ in: "query"
+ required: false
+ type: "string"
+ enum:
+ - "IMMEDIATE"
+ - "END_OF_TERM"
+ - name: "billingPolicy"
+ in: "query"
+ required: false
+ type: "string"
+ enum:
+ - "START_OF_TERM"
+ - "END_OF_TERM"
+ - "IMMEDIATE"
+ - "ILLEGAL"
+ - name: "useRequestedDateForBilling"
in: "query"
required: false
type: "boolean"
default: false
+ - name: "pluginProperty"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -9787,33 +9809,28 @@ paths:
"204":
description: "Successful operation"
"400":
- description: "Invalid entitlement supplied"
+ description: "Invalid subscription id supplied"
+ "404":
+ description: "Entitlement not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/subscriptions/{subscriptionId}/tags:
+ /1.0/kb/subscriptions:
get:
tags:
- "Subscription"
- summary: "Retrieve subscription tags"
+ summary: "Retrieve a subscription by external key"
description: ""
- operationId: "getSubscriptionTags"
+ operationId: "getSubscriptionByKey"
produces:
- "application/json"
parameters:
- - name: "subscriptionId"
- in: "path"
+ - name: "externalKey"
+ in: "query"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "includedDeleted"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "audit"
+ - name: "audit"
in: "query"
required: false
type: "string"
@@ -9826,11 +9843,7 @@ paths:
"200":
description: "successful operation"
schema:
- type: "array"
- items:
- $ref: "#/definitions/Tag"
- "400":
- description: "Invalid subscription id supplied"
+ $ref: "#/definitions/Subscription"
"404":
description: "Subscription not found"
security:
@@ -9840,26 +9853,62 @@ paths:
post:
tags:
- "Subscription"
- operationId: "createSubscriptionTags"
+ summary: "Create a subscription"
+ description: ""
+ operationId: "createSubscription"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- - name: "subscriptionId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- in: "body"
name: "body"
required: true
schema:
- type: "array"
- items:
- type: "string"
- format: "uuid"
+ $ref: "#/definitions/Subscription"
+ - name: "entitlementDate"
+ in: "query"
+ required: false
+ type: "string"
+ format: "date"
+ - name: "billingDate"
+ in: "query"
+ required: false
+ type: "string"
+ format: "date"
+ - name: "renameKeyIfExistsAndUnused"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: true
+ - name: "migrated"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "skipResponse"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "callCompletion"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "callTimeoutSec"
+ in: "query"
+ required: false
+ type: "integer"
+ default: 3
+ format: "int64"
+ - name: "pluginProperty"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -9874,37 +9923,74 @@ paths:
type: "string"
responses:
"201":
- description: "Tag created successfully"
- "400":
- description: "Invalid subscription id supplied"
+ description: "Subscription created successfully"
+ schema:
+ $ref: "#/definitions/Subscription"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- delete:
+ /1.0/kb/subscriptions/createSubscriptionWithAddOns:
+ post:
tags:
- "Subscription"
- summary: "Remove tags from subscription"
+ summary: "Create an entitlement with addOn products"
description: ""
- operationId: "deleteSubscriptionTags"
+ operationId: "createSubscriptionWithAddOns"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- - name: "subscriptionId"
- in: "path"
+ - in: "body"
+ name: "body"
required: true
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/Subscription"
+ - name: "entitlementDate"
+ in: "query"
+ required: false
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "tagDef"
+ 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"
- format: "uuid"
collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
@@ -9919,40 +10005,69 @@ paths:
required: false
type: "string"
responses:
- "204":
- description: "Successful operation"
- "400":
- description: "Invalid subscription id supplied"
+ "201":
+ description: "Subscriptions created successfully"
+ schema:
+ $ref: "#/definitions/Bundle"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/subscriptions/{subscriptionId}/block:
+ /1.0/kb/subscriptions/createSubscriptionsWithAddOns:
post:
tags:
- "Subscription"
- summary: "Block a subscription"
+ summary: "Create multiple entitlements with addOn products"
description: ""
- operationId: "addSubscriptionBlockingState"
+ operationId: "createSubscriptionsWithAddOns"
consumes:
- "application/json"
+ produces:
+ - "application/json"
parameters:
- - name: "subscriptionId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- in: "body"
name: "body"
required: true
schema:
- $ref: "#/definitions/BlockingState"
- - name: "requestedDate"
+ 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
@@ -9974,26 +10089,22 @@ paths:
type: "string"
responses:
"201":
- description: "Blocking state created successfully"
+ description: "Subscriptions created successfully"
schema:
type: "array"
items:
- $ref: "#/definitions/BlockingState"
- "400":
- description: "Invalid subscription id supplied"
- "404":
- description: "Subscription not found"
+ $ref: "#/definitions/Bundle"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/subscriptions/{subscriptionId}/customFields:
+ /1.0/kb/subscriptions/{subscriptionId}/auditLogsWithHistory:
get:
tags:
- "Subscription"
- summary: "Retrieve subscription custom fields"
+ summary: "Retrieve subscription audit logs with history by id"
description: ""
- operationId: "getSubscriptionCustomFields"
+ operationId: "getSubscriptionAuditLogsWithHistory"
produces:
- "application/json"
parameters:
@@ -10003,36 +10114,55 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "audit"
- in: "query"
- required: false
- type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
responses:
"200":
description: "successful operation"
schema:
type: "array"
items:
- $ref: "#/definitions/CustomField"
- "400":
- description: "Invalid subscription id supplied"
+ $ref: "#/definitions/AuditLog"
+ "404":
+ description: "Subscription not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- post:
+ /1.0/kb/subscriptions/events/{eventId}/auditLogsWithHistory:
+ get:
tags:
- "Subscription"
- summary: "Add custom fields to subscription"
+ summary: "Retrieve subscription event audit logs with history by id"
description: ""
- operationId: "createSubscriptionCustomFields"
- consumes:
+ operationId: "getSubscriptionEventAuditLogsWithHistory"
+ produces:
- "application/json"
+ parameters:
+ - name: "eventId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/AuditLog"
+ "404":
+ description: "Subscription event not found"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ /1.0/kb/subscriptions/{subscriptionId}/uncancel:
+ put:
+ tags:
+ - "Subscription"
+ summary: "Un-cancel an entitlement"
+ description: ""
+ operationId: "uncancelSubscriptionPlan"
produces:
- "application/json"
parameters:
@@ -10042,58 +10172,13 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- type: "array"
- items:
- $ref: "#/definitions/CustomField"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
+ - name: "pluginProperty"
+ in: "query"
required: false
- type: "string"
- responses:
- "201":
- description: "Custom field created successfully"
- "400":
- description: "Invalid subscription id supplied"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- put:
- tags:
- - "Subscription"
- summary: "Modify custom fields to subscription"
- description: ""
- operationId: "modifySubscriptionCustomFields"
- consumes:
- - "application/json"
- produces:
- - "application/json"
- parameters:
- - name: "subscriptionId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- type: "array"
- items:
- $ref: "#/definitions/CustomField"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -10111,18 +10196,19 @@ paths:
description: "Successful operation"
"400":
description: "Invalid subscription id supplied"
+ "404":
+ description: "Entitlement not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- delete:
+ /1.0/kb/subscriptions/{subscriptionId}/undoChangePlan:
+ put:
tags:
- "Subscription"
- summary: "Remove custom fields from subscription"
+ summary: "Undo a pending change plan on an entitlement"
description: ""
- operationId: "deleteSubscriptionCustomFields"
- consumes:
- - "application/json"
+ operationId: "undoChangeSubscriptionPlan"
produces:
- "application/json"
parameters:
@@ -10132,13 +10218,12 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "customField"
+ - name: "pluginProperty"
in: "query"
required: false
type: "array"
items:
type: "string"
- format: "uuid"
collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
@@ -10157,17 +10242,19 @@ paths:
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}/quantity:
+ /1.0/kb/subscriptions/{subscriptionId}/bcd:
put:
tags:
- "Subscription"
- summary: "Update the quantity associated to a subscription"
+ summary: "Update the BCD associated to a subscription"
description: ""
- operationId: "updateSubscriptionQuantity"
+ operationId: "updateSubscriptionBCD"
consumes:
- "application/json"
produces:
@@ -10189,7 +10276,7 @@ paths:
required: false
type: "string"
format: "date"
- - name: "forceNewQuantityWithPastEffectiveDate"
+ - name: "forceNewBcdWithPastEffectiveDate"
in: "query"
required: false
type: "boolean"
@@ -10215,68 +10302,39 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/subscriptions/createSubscriptionWithAddOns:
- post:
+ /1.0/kb/subscriptions/{subscriptionId}/quantity:
+ put:
tags:
- "Subscription"
- summary: "Create an entitlement with addOn products"
+ summary: "Update the quantity associated to a subscription"
description: ""
- operationId: "createSubscriptionWithAddOns"
+ operationId: "updateSubscriptionQuantity"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
+ - name: "subscriptionId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
- in: "body"
name: "body"
required: true
schema:
- type: "array"
- items:
- $ref: "#/definitions/Subscription"
- - name: "entitlementDate"
- in: "query"
- required: false
- type: "string"
- format: "date"
- - name: "billingDate"
+ $ref: "#/definitions/Subscription"
+ - name: "effectiveFromDate"
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"
+ - name: "forceNewQuantityWithPastEffectiveDate"
in: "query"
required: false
type: "boolean"
default: false
- - name: "callTimeoutSec"
- in: "query"
- required: false
- type: "integer"
- default: 3
- format: "int64"
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -10290,68 +10348,10 @@ paths:
required: false
type: "string"
responses:
- "201":
- description: "Subscriptions created successfully"
- schema:
- $ref: "#/definitions/Bundle"
- 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"
- parameters:
- - name: "subscriptionId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
- "404":
- description: "Subscription not found"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/subscriptions/events/{eventId}/auditLogsWithHistory:
- get:
- tags:
- - "Subscription"
- summary: "Retrieve subscription event audit logs with history by id"
- description: ""
- operationId: "getSubscriptionEventAuditLogsWithHistory"
- produces:
- - "application/json"
- parameters:
- - name: "eventId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
- "404":
- description: "Subscription event not found"
+ "204":
+ description: "Successful operation"
+ "400":
+ description: "Invalid entitlement supplied"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -10428,35 +10428,6 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/tagDefinitions/{tagDefinitionId}/auditLogsWithHistory:
- get:
- tags:
- - "TagDefinition"
- summary: "Retrieve tag definition audit logs with history by id"
- description: ""
- operationId: "getTagDefinitionAuditLogsWithHistory"
- produces:
- - "application/json"
- parameters:
- - name: "tagDefinitionId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
- "404":
- description: "Account not found"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
/1.0/kb/tagDefinitions:
get:
tags:
@@ -10526,17 +10497,17 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/tags/{tagId}/auditLogsWithHistory:
+ /1.0/kb/tagDefinitions/{tagDefinitionId}/auditLogsWithHistory:
get:
tags:
- - "Tag"
- summary: "Retrieve tag audit logs with history by id"
+ - "TagDefinition"
+ summary: "Retrieve tag definition audit logs with history by id"
description: ""
- operationId: "getTagAuditLogsWithHistory"
+ operationId: "getTagDefinitionAuditLogsWithHistory"
produces:
- "application/json"
parameters:
- - name: "tagId"
+ - name: "tagDefinitionId"
in: "path"
required: true
type: "string"
@@ -10555,21 +10526,16 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/tags/search/{searchKey}:
+ /1.0/kb/tags/pagination:
get:
tags:
- "Tag"
- summary: "Search tags"
+ summary: "List tags"
description: ""
- operationId: "searchTags"
+ operationId: "getTags"
produces:
- "application/json"
parameters:
- - name: "searchKey"
- in: "path"
- required: true
- type: "string"
- pattern: ".*"
- name: "offset"
in: "query"
required: false
@@ -10602,18 +10568,23 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/tags/pagination:
+ /1.0/kb/tags/search/{searchKey}:
get:
tags:
- "Tag"
- summary: "List tags"
+ summary: "Search tags"
description: ""
- operationId: "getTags"
+ operationId: "searchTags"
produces:
- "application/json"
parameters:
- - name: "offset"
- in: "query"
+ - name: "searchKey"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: ".*"
+ - name: "offset"
+ in: "query"
required: false
type: "integer"
default: 0
@@ -10644,105 +10615,31 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/tenants/uploadPluginPaymentStateMachineConfig/{pluginName}:
+ /1.0/kb/tags/{tagId}/auditLogsWithHistory:
get:
tags:
- - "Tenant"
- summary: "Retrieve a per tenant payment state machine for a plugin"
+ - "Tag"
+ summary: "Retrieve tag audit logs with history by id"
description: ""
- operationId: "getPluginPaymentStateMachineConfig"
+ operationId: "getTagAuditLogsWithHistory"
produces:
- "application/json"
parameters:
- - name: "pluginName"
+ - name: "tagId"
in: "path"
required: true
type: "string"
- pattern: ".*"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
responses:
"200":
description: "successful operation"
schema:
- $ref: "#/definitions/TenantKeyValue"
- "400":
- description: "Invalid tenantId 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"
- parameters:
- - name: "pluginName"
- in: "path"
- required: true
- type: "string"
- pattern: ".*"
- - in: "body"
- name: "body"
- required: true
- schema:
- type: "string"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
- responses:
- "201":
- description: "Per tenant state machine uploaded successfully"
- schema:
- $ref: "#/definitions/TenantKeyValue"
- "400":
- description: "Invalid tenantId supplied"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- delete:
- tags:
- - "Tenant"
- summary: "Delete a per tenant payment state machine for a plugin"
- description: ""
- operationId: "deletePluginPaymentStateMachineConfig"
- parameters:
- - name: "pluginName"
- in: "path"
- required: true
- type: "string"
- pattern: ".*"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
- responses:
- "204":
- description: "Successful operation"
- "400":
- description: "Invalid tenantId supplied"
+ type: "array"
+ items:
+ $ref: "#/definitions/AuditLog"
+ "404":
+ description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -10812,17 +10709,17 @@ paths:
description: "Tenant already exists"
security:
- basicAuth: []
- /1.0/kb/tenants/userKeyValue/{keyName}:
+ /1.0/kb/tenants/uploadPluginPaymentStateMachineConfig/{pluginName}:
get:
tags:
- "Tenant"
- summary: "Retrieve a per tenant user key/value"
+ summary: "Retrieve a per tenant payment state machine for a plugin"
description: ""
- operationId: "getUserKeyValue"
+ operationId: "getPluginPaymentStateMachineConfig"
produces:
- "application/json"
parameters:
- - name: "keyName"
+ - name: "pluginName"
in: "path"
required: true
type: "string"
@@ -10841,15 +10738,15 @@ paths:
post:
tags:
- "Tenant"
- summary: "Add a per tenant user key/value"
+ summary: "Add a per tenant payment state machine for a plugin"
description: ""
- operationId: "insertUserKeyValue"
+ operationId: "uploadPluginPaymentStateMachineConfig"
consumes:
- "text/plain"
produces:
- "application/json"
parameters:
- - name: "keyName"
+ - name: "pluginName"
in: "path"
required: true
type: "string"
@@ -10873,7 +10770,7 @@ paths:
type: "string"
responses:
"201":
- description: "Per tenant config uploaded successfully"
+ description: "Per tenant state machine uploaded successfully"
schema:
$ref: "#/definitions/TenantKeyValue"
"400":
@@ -10885,11 +10782,11 @@ paths:
delete:
tags:
- "Tenant"
- summary: "Delete a per tenant user key/value"
+ summary: "Delete a per tenant payment state machine for a plugin"
description: ""
- operationId: "deleteUserKeyValue"
+ operationId: "deletePluginPaymentStateMachineConfig"
parameters:
- - name: "keyName"
+ - name: "pluginName"
in: "path"
required: true
type: "string"
@@ -10915,63 +10812,6 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/tenants/{tenantId}:
- get:
- tags:
- - "Tenant"
- summary: "Retrieve a tenant by id"
- description: ""
- operationId: "getTenant"
- produces:
- - "application/json"
- parameters:
- - name: "tenantId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- responses:
- "200":
- description: "successful operation"
- schema:
- $ref: "#/definitions/Tenant"
- "400":
- description: "Invalid tenantId supplied"
- "404":
- description: "Tenant not found"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/tenants/uploadPerTenantConfig/{keyPrefix}/search:
- get:
- tags:
- - "Tenant"
- summary: "Retrieve a per tenant key value based on key prefix"
- description: ""
- operationId: "getAllPluginConfiguration"
- produces:
- - "application/json"
- parameters:
- - name: "keyPrefix"
- in: "path"
- required: true
- type: "string"
- pattern: ".*"
- responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/TenantKeyValue"
- "400":
- description: "Invalid tenantId supplied"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
/1.0/kb/tenants/uploadPerTenantConfig:
get:
tags:
@@ -11250,88 +11090,53 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/paymentTransactions/{transactionId}:
+ /1.0/kb/tenants/userKeyValue/{keyName}:
get:
tags:
- - "PaymentTransaction"
- summary: "Retrieve a payment by transaction id"
+ - "Tenant"
+ summary: "Retrieve a per tenant user key/value"
description: ""
- operationId: "getPaymentByTransactionId"
+ operationId: "getUserKeyValue"
produces:
- "application/json"
parameters:
- - name: "transactionId"
+ - name: "keyName"
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: ".*"
responses:
"200":
description: "successful operation"
schema:
- $ref: "#/definitions/Payment"
- "404":
- description: "Payment not found"
+ $ref: "#/definitions/TenantKeyValue"
+ "400":
+ description: "Invalid tenantId supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
post:
tags:
- - "PaymentTransaction"
- summary: "Mark a pending payment transaction as succeeded or failed"
+ - "Tenant"
+ summary: "Add a per tenant user key/value"
description: ""
- operationId: "notifyStateChanged"
+ operationId: "insertUserKeyValue"
consumes:
- - "application/json"
+ - "text/plain"
produces:
- "application/json"
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:
- $ref: "#/definitions/PaymentTransaction"
- - name: "controlPluginName"
- in: "query"
- required: false
- type: "array"
- items:
type: "string"
- collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -11346,110 +11151,156 @@ paths:
type: "string"
responses:
"201":
- description: "Successfully notifiy state change"
+ description: "Per tenant config uploaded successfully"
schema:
- $ref: "#/definitions/Payment"
+ $ref: "#/definitions/TenantKeyValue"
"400":
- description: "Invalid paymentId supplied"
- "404":
- description: "Account or Payment not found"
+ description: "Invalid tenantId supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/paymentTransactions/{transactionId}/customFields:
+ delete:
+ tags:
+ - "Tenant"
+ summary: "Delete a per tenant user key/value"
+ description: ""
+ operationId: "deleteUserKeyValue"
+ parameters:
+ - name: "keyName"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: ".*"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ required: false
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
+ required: false
+ type: "string"
+ responses:
+ "204":
+ description: "Successful operation"
+ "400":
+ description: "Invalid tenantId supplied"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ /1.0/kb/tenants/uploadPerTenantConfig/{keyPrefix}/search:
get:
tags:
- - "PaymentTransaction"
- summary: "Retrieve payment transaction custom fields"
+ - "Tenant"
+ summary: "Retrieve a per tenant key value based on key prefix"
description: ""
- operationId: "getTransactionCustomFields"
+ operationId: "getAllPluginConfiguration"
produces:
- "application/json"
parameters:
- - name: "transactionId"
+ - name: "keyPrefix"
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: ".*"
responses:
"200":
description: "successful operation"
schema:
type: "array"
items:
- $ref: "#/definitions/CustomField"
+ $ref: "#/definitions/TenantKeyValue"
"400":
- description: "Invalid transaction id supplied"
+ description: "Invalid tenantId supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- post:
+ /1.0/kb/tenants/{tenantId}:
+ get:
tags:
- - "PaymentTransaction"
- summary: "Add custom fields to payment transaction"
+ - "Tenant"
+ summary: "Retrieve a tenant by id"
description: ""
- operationId: "createTransactionCustomFields"
- consumes:
- - "application/json"
+ operationId: "getTenant"
produces:
- "application/json"
parameters:
- - name: "transactionId"
+ - name: "tenantId"
in: "path"
required: true
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- type: "array"
- items:
- $ref: "#/definitions/CustomField"
- - name: "X-Killbill-CreatedBy"
- in: "header"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ $ref: "#/definitions/Tenant"
+ "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"
+ parameters:
+ - name: "transactionId"
+ in: "path"
required: true
type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - name: "includedDeleted"
+ in: "query"
required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
+ type: "boolean"
+ default: false
+ - name: "audit"
+ in: "query"
required: false
type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
responses:
- "201":
- description: "Custom field created successfully"
+ "200":
+ description: "successful operation"
schema:
type: "array"
items:
- $ref: "#/definitions/CustomField"
+ $ref: "#/definitions/Tag"
"400":
description: "Invalid transaction id supplied"
+ "404":
+ description: "Invoice not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- put:
+ post:
tags:
- "PaymentTransaction"
- summary: "Modify custom fields to payment transaction"
+ summary: "Add tags to payment transaction"
description: ""
- operationId: "modifyTransactionCustomFields"
+ operationId: "createTransactionTags"
consumes:
- "application/json"
produces:
@@ -11467,7 +11318,8 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/CustomField"
+ type: "string"
+ format: "uuid"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -11481,8 +11333,12 @@ paths:
required: false
type: "string"
responses:
- "204":
- description: "Successful operation"
+ "201":
+ description: "Tag created successfully"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/Tag"
"400":
description: "Invalid transaction id supplied"
security:
@@ -11492,9 +11348,9 @@ paths:
delete:
tags:
- "PaymentTransaction"
- summary: "Remove custom fields from payment transaction"
+ summary: "Remove tags from payment transaction"
description: ""
- operationId: "deleteTransactionCustomFields"
+ operationId: "deleteTransactionTags"
consumes:
- "application/json"
produces:
@@ -11506,7 +11362,7 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "customField"
+ - name: "tagDef"
in: "query"
required: false
type: "array"
@@ -11535,13 +11391,13 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/paymentTransactions/{transactionId}/tags:
+ /1.0/kb/paymentTransactions/{transactionId}/customFields:
get:
tags:
- "PaymentTransaction"
- summary: "Retrieve payment transaction tags"
+ summary: "Retrieve payment transaction custom fields"
description: ""
- operationId: "getTransactionTags"
+ operationId: "getTransactionCustomFields"
produces:
- "application/json"
parameters:
@@ -11551,11 +11407,6 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "includedDeleted"
- in: "query"
- required: false
- type: "boolean"
- default: false
- name: "audit"
in: "query"
required: false
@@ -11571,11 +11422,9 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/Tag"
+ $ref: "#/definitions/CustomField"
"400":
description: "Invalid transaction id supplied"
- "404":
- description: "Invoice not found"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -11583,9 +11432,9 @@ paths:
post:
tags:
- "PaymentTransaction"
- summary: "Add tags to payment transaction"
+ summary: "Add custom fields to payment transaction"
description: ""
- operationId: "createTransactionTags"
+ operationId: "createTransactionCustomFields"
consumes:
- "application/json"
produces:
@@ -11603,8 +11452,7 @@ paths:
schema:
type: "array"
items:
- type: "string"
- format: "uuid"
+ $ref: "#/definitions/CustomField"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -11619,23 +11467,23 @@ paths:
type: "string"
responses:
"201":
- description: "Tag created successfully"
+ description: "Custom field created successfully"
schema:
type: "array"
items:
- $ref: "#/definitions/Tag"
+ $ref: "#/definitions/CustomField"
"400":
description: "Invalid transaction id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- delete:
+ put:
tags:
- "PaymentTransaction"
- summary: "Remove tags from payment transaction"
+ summary: "Modify custom fields to payment transaction"
description: ""
- operationId: "deleteTransactionTags"
+ operationId: "modifyTransactionCustomFields"
consumes:
- "application/json"
produces:
@@ -11647,14 +11495,13 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "tagDef"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- format: "uuid"
- collectionFormat: "multi"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/CustomField"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -11676,13 +11523,14 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/paymentTransactions/{transactionId}/auditLogsWithHistory:
- get:
+ delete:
tags:
- "PaymentTransaction"
- summary: "Retrieve payment transaction audit logs with history by id"
+ summary: "Remove custom fields from payment transaction"
description: ""
- operationId: "getTransactionAuditLogsWithHistory"
+ operationId: "deleteTransactionCustomFields"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
@@ -11692,33 +11540,51 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ - name: "customField"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ format: "uuid"
+ collectionFormat: "multi"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ required: false
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
+ required: false
+ type: "string"
responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
- "404":
- description: "Account not found"
+ "204":
+ description: "Successful operation"
+ "400":
+ description: "Invalid transaction id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/paymentTransactions:
+ /1.0/kb/paymentTransactions/{transactionId}:
get:
tags:
- "PaymentTransaction"
- summary: "Retrieve a payment by transaction external key"
+ summary: "Retrieve a payment by transaction id"
description: ""
- operationId: "getPaymentByTransactionExternalKey"
+ operationId: "getPaymentByTransactionId"
produces:
- "application/json"
parameters:
- - name: "transactionExternalKey"
- in: "query"
+ - name: "transactionId"
+ in: "path"
required: true
type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
- name: "withPluginInfo"
in: "query"
required: false
@@ -11756,36 +11622,84 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/usages/{subscriptionId}/{unitType}:
- get:
+ post:
tags:
- - "Usage"
- summary: "Retrieve usage for a subscription and unit type"
+ - "PaymentTransaction"
+ summary: "Mark a pending payment transaction as succeeded or failed"
description: ""
- operationId: "getUsage"
+ operationId: "notifyStateChanged"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
- - name: "subscriptionId"
+ - name: "transactionId"
in: "path"
required: true
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "unitType"
- in: "path"
+ - in: "body"
+ name: "body"
required: true
- type: "string"
- - name: "startDate"
+ schema:
+ $ref: "#/definitions/PaymentTransaction"
+ - name: "controlPluginName"
in: "query"
required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
type: "string"
- format: "date"
- - name: "endDate"
- in: "query"
+ - name: "X-Killbill-Reason"
+ in: "header"
required: false
type: "string"
- format: "date"
+ - name: "X-Killbill-Comment"
+ in: "header"
+ required: false
+ type: "string"
+ responses:
+ "201":
+ description: "Successfully notifiy state change"
+ schema:
+ $ref: "#/definitions/Payment"
+ "400":
+ description: "Invalid paymentId supplied"
+ "404":
+ description: "Account or Payment not found"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ /1.0/kb/paymentTransactions:
+ get:
+ tags:
+ - "PaymentTransaction"
+ summary: "Retrieve a payment by transaction external key"
+ description: ""
+ operationId: "getPaymentByTransactionExternalKey"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "transactionExternalKey"
+ in: "query"
+ required: true
+ type: "string"
+ - name: "withPluginInfo"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "withAttempts"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
- name: "pluginProperty"
in: "query"
required: false
@@ -11793,51 +11707,99 @@ paths:
items:
type: "string"
collectionFormat: "multi"
+ - name: "audit"
+ in: "query"
+ required: false
+ type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
responses:
"200":
description: "successful operation"
schema:
- $ref: "#/definitions/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:
- post:
+ /1.0/kb/paymentTransactions/{transactionId}/auditLogsWithHistory:
+ get:
tags:
- - "Usage"
- summary: "Record usage for a subscription"
+ - "PaymentTransaction"
+ summary: "Retrieve payment transaction audit logs with history by id"
description: ""
- operationId: "recordUsage"
- consumes:
+ operationId: "getTransactionAuditLogsWithHistory"
+ produces:
- "application/json"
+ 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:
- - in: "body"
- name: "body"
+ - name: "subscriptionId"
+ in: "path"
required: true
- schema:
- $ref: "#/definitions/SubscriptionUsageRecord"
- - name: "X-Killbill-CreatedBy"
- in: "header"
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - name: "unitType"
+ in: "path"
required: true
type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
+ - name: "startDate"
+ in: "query"
required: false
type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
+ format: "date"
+ - name: "endDate"
+ in: "query"
required: false
type: "string"
+ format: "date"
+ - name: "pluginProperty"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
responses:
"200":
- description: "Successfully recorded usage data change"
+ description: "successful operation"
+ schema:
+ $ref: "#/definitions/RolledUpUsage"
"400":
- description: "Invalid subscription (e.g. inactive)"
+ description: "Missing start date or end date"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -11886,6 +11848,44 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ /1.0/kb/usages:
+ post:
+ tags:
+ - "Usage"
+ summary: "Record usage for a subscription"
+ description: ""
+ operationId: "recordUsage"
+ consumes:
+ - "application/json"
+ produces:
+ - "application/json"
+ parameters:
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/SubscriptionUsageRecord"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ required: false
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
+ required: false
+ type: "string"
+ responses:
+ "200":
+ description: "Successfully recorded usage data change"
+ "400":
+ description: "Invalid subscription (e.g. inactive)"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
securityDefinitions:
basicAuth:
type: "basic"
@@ -11898,33 +11898,199 @@ securityDefinitions:
name: "X-Killbill-ApiSecret"
in: "header"
definitions:
- Account:
+ AuditLog:
type: "object"
properties:
- accountId:
+ changeType:
+ type: "string"
+ changeDate:
+ type: "string"
+ format: "date-time"
+ 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"
- name:
+ changedBy:
type: "string"
- firstNameLength:
- type: "integer"
- format: "int32"
- externalKey:
+ reasonCode:
type: "string"
- email:
+ comments:
type: "string"
- billCycleDayLocal:
- type: "integer"
- format: "int32"
- currency:
+ userToken:
type: "string"
- enum:
- - "AED"
- - "AFN"
- - "ALL"
- - "AMD"
- - "ANG"
- - "AOA"
+ 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:
+ blockedId:
+ type: "string"
+ format: "uuid"
+ stateName:
+ type: "string"
+ service:
+ type: "string"
+ isBlockChange:
+ type: "boolean"
+ isBlockEntitlement:
+ type: "boolean"
+ isBlockBilling:
+ type: "boolean"
+ effectiveDate:
+ type: "string"
+ format: "date-time"
+ type:
+ type: "string"
+ enum:
+ - "SUBSCRIPTION"
+ - "SUBSCRIPTION_BUNDLE"
+ - "ACCOUNT"
+ auditLogs:
+ type: "array"
+ items:
+ $ref: "#/definitions/AuditLog"
+ Account:
+ type: "object"
+ properties:
+ accountId:
+ type: "string"
+ format: "uuid"
+ name:
+ type: "string"
+ firstNameLength:
+ type: "integer"
+ format: "int32"
+ externalKey:
+ type: "string"
+ email:
+ type: "string"
+ billCycleDayLocal:
+ type: "integer"
+ format: "int32"
+ currency:
+ type: "string"
+ enum:
+ - "AED"
+ - "AFN"
+ - "ALL"
+ - "AMD"
+ - "ANG"
+ - "AOA"
- "ARS"
- "AUD"
- "AWG"
@@ -12097,444 +12263,75 @@ definitions:
format: "date-time"
timeZone:
type: "string"
- address1:
- type: "string"
- address2:
- type: "string"
- postalCode:
- type: "string"
- company:
- type: "string"
- city:
- type: "string"
- state:
- type: "string"
- country:
- type: "string"
- locale:
- type: "string"
- phone:
- type: "string"
- notes:
- type: "string"
- isMigrated:
- type: "boolean"
- accountBalance:
- type: "number"
- accountCBA:
- type: "number"
- auditLogs:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
- AuditLog:
- type: "object"
- properties:
- changeType:
- type: "string"
- changeDate:
- type: "string"
- format: "date-time"
- 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"
- changedBy:
- type: "string"
- reasonCode:
- type: "string"
- comments:
- type: "string"
- userToken:
- type: "string"
- history:
- $ref: "#/definitions/Entity"
- Entity:
- type: "object"
- properties:
- id:
- type: "string"
- format: "uuid"
- createdDate:
- type: "string"
- format: "date-time"
- updatedDate:
- type: "string"
- format: "date-time"
- AccountEmail:
- type: "object"
- required:
- - "email"
- properties:
- accountId:
- type: "string"
- format: "uuid"
- email:
- type: "string"
- auditLogs:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
- Tag:
- type: "object"
- properties:
- tagId:
- type: "string"
- format: "uuid"
- objectType:
- type: "string"
- enum:
- - "ACCOUNT"
- - "ACCOUNT_EMAIL"
- - "BLOCKING_STATES"
- - "BUNDLE"
- - "CUSTOM_FIELD"
- - "INVOICE"
- - "PAYMENT"
- - "TRANSACTION"
- - "INVOICE_ITEM"
- - "INVOICE_PAYMENT"
- - "SUBSCRIPTION"
- - "SUBSCRIPTION_EVENT"
- - "SERVICE_BROADCAST"
- - "PAYMENT_ATTEMPT"
- - "PAYMENT_METHOD"
- - "TAG"
- - "TAG_DEFINITION"
- - "TENANT"
- - "TENANT_KVS"
- objectId:
- type: "string"
- format: "uuid"
- tagDefinitionId:
- type: "string"
- format: "uuid"
- tagDefinitionName:
- type: "string"
- auditLogs:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
- 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:
+ address1:
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:
+ address2:
type: "string"
- enum:
- - "TRIAL"
- - "DISCOUNT"
- - "FIXEDTERM"
- - "EVERGREEN"
- priceList:
+ postalCode:
type: "string"
- planName:
+ company:
type: "string"
- state:
+ city:
type: "string"
- enum:
- - "PENDING"
- - "ACTIVE"
- - "BLOCKED"
- - "CANCELLED"
- - "EXPIRED"
- sourceType:
+ state:
type: "string"
- enum:
- - "NATIVE"
- - "MIGRATED"
- - "TRANSFERRED"
- cancelledDate:
+ country:
type: "string"
- format: "date-time"
- chargedThroughDate:
+ locale:
type: "string"
- format: "date"
- billingStartDate:
+ phone:
type: "string"
- format: "date-time"
- billingEndDate:
+ notes:
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"
+ isMigrated:
+ type: "boolean"
+ accountBalance:
+ type: "number"
+ accountCBA:
+ type: "number"
auditLogs:
type: "array"
items:
$ref: "#/definitions/AuditLog"
- TierPrice:
+ AccountEmail:
type: "object"
+ required:
+ - "email"
properties:
- blockPrices:
+ accountId:
+ type: "string"
+ format: "uuid"
+ email:
+ type: "string"
+ auditLogs:
type: "array"
items:
- $ref: "#/definitions/BlockPrice"
- UsagePrice:
+ $ref: "#/definitions/AuditLog"
+ InvoicePayment:
type: "object"
properties:
- usageName:
+ targetInvoiceId:
type: "string"
- usageType:
+ format: "uuid"
+ accountId:
type: "string"
- enum:
- - "CAPACITY"
- - "CONSUMABLE"
- billingMode:
+ format: "uuid"
+ paymentId:
type: "string"
- enum:
- - "IN_ADVANCE"
- - "IN_ARREAR"
- tierBlockPolicy:
+ format: "uuid"
+ paymentNumber:
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:
+ paymentExternalKey:
+ type: "string"
+ authAmount:
+ type: "number"
+ capturedAmount:
+ type: "number"
+ purchasedAmount:
+ type: "number"
+ refundedAmount:
+ type: "number"
+ creditedAmount:
type: "number"
currency:
type: "string"
@@ -12704,128 +12501,58 @@ 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:
+ paymentMethodId:
type: "string"
format: "uuid"
- bundleKeys:
- type: "string"
- credits:
- type: "array"
- items:
- $ref: "#/definitions/InvoiceItem"
- items:
+ transactions:
type: "array"
items:
- $ref: "#/definitions/InvoiceItem"
- trackingIds:
+ $ref: "#/definitions/PaymentTransaction"
+ paymentAttempts:
type: "array"
items:
- type: "string"
- isParentInvoice:
- type: "boolean"
- parentInvoiceId:
- type: "string"
- format: "uuid"
- parentAccountId:
- type: "string"
- format: "uuid"
+ $ref: "#/definitions/PaymentAttempt"
auditLogs:
type: "array"
items:
$ref: "#/definitions/AuditLog"
- InvoiceItem:
+ PaymentAttempt:
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:
+ paymentMethodId:
type: "string"
format: "uuid"
- bundleId:
+ paymentExternalKey:
type: "string"
- format: "uuid"
- subscriptionId:
+ transactionId:
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:
+ transactionExternalKey:
type: "string"
- itemType:
+ transactionType:
type: "string"
enum:
- - "EXTERNAL_CHARGE"
- - "FIXED"
- - "RECURRING"
- - "REPAIR_ADJ"
- - "CBA_ADJ"
- - "CREDIT_ADJ"
- - "ITEM_ADJ"
- - "USAGE"
- - "TAX"
- - "PARENT_SUMMARY"
- description:
- type: "string"
- startDate:
+ - "AUTHORIZE"
+ - "CAPTURE"
+ - "CHARGEBACK"
+ - "CREDIT"
+ - "PURCHASE"
+ - "REFUND"
+ - "VOID"
+ effectiveDate:
type: "string"
- format: "date"
- endDate:
+ format: "date-time"
+ stateName:
type: "string"
- format: "date"
amount:
type: "number"
- rate:
- type: "number"
+ description: "Transaction amount, required except for void operations"
currency:
type: "string"
+ description: "Amount currency (account currency unless specified)"
enum:
- "AED"
- "AFN"
@@ -12992,49 +12719,46 @@ definitions:
- "ZMW"
- "ZWD"
- "BTC"
- quantity:
- type: "number"
- itemDetails:
- type: "string"
- catalogEffectiveDate:
+ pluginName:
type: "string"
- format: "date-time"
- childItems:
+ pluginProperties:
type: "array"
items:
- $ref: "#/definitions/InvoiceItem"
+ $ref: "#/definitions/PluginProperty"
auditLogs:
type: "array"
items:
$ref: "#/definitions/AuditLog"
- InvoicePayment:
+ PaymentTransaction:
type: "object"
properties:
- targetInvoiceId:
+ transactionId:
type: "string"
format: "uuid"
- accountId:
+ transactionExternalKey:
type: "string"
- format: "uuid"
paymentId:
type: "string"
format: "uuid"
- paymentNumber:
- type: "string"
+ description: "Associated payment id, required when notifying state transitions"
paymentExternalKey:
type: "string"
- authAmount:
- type: "number"
- capturedAmount:
- type: "number"
- purchasedAmount:
- type: "number"
- refundedAmount:
- type: "number"
- creditedAmount:
+ 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"
@@ -13201,58 +12925,13 @@ definitions:
- "ZMW"
- "ZWD"
- "BTC"
- paymentMethodId:
- type: "string"
- format: "uuid"
- transactions:
- type: "array"
- items:
- $ref: "#/definitions/PaymentTransaction"
- paymentAttempts:
- type: "array"
- items:
- $ref: "#/definitions/PaymentAttempt"
- auditLogs:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
- PaymentAttempt:
- type: "object"
- properties:
- accountId:
- type: "string"
- format: "uuid"
- paymentMethodId:
- type: "string"
- format: "uuid"
- paymentExternalKey:
- type: "string"
- transactionId:
- type: "string"
- format: "uuid"
- transactionExternalKey:
- type: "string"
- transactionType:
- type: "string"
- enum:
- - "AUTHORIZE"
- - "CAPTURE"
- - "CHARGEBACK"
- - "CREDIT"
- - "PURCHASE"
- - "REFUND"
- - "VOID"
effectiveDate:
type: "string"
format: "date-time"
- stateName:
- type: "string"
- amount:
+ processedAmount:
type: "number"
- description: "Transaction amount, required except for void operations"
- currency:
+ processedCurrency:
type: "string"
- description: "Amount currency (account currency unless specified)"
enum:
- "AED"
- "AFN"
@@ -13419,46 +13098,375 @@ definitions:
- "ZMW"
- "ZWD"
- "BTC"
+ status:
+ type: "string"
+ description: "Transaction status, required for state change notifications"
+ enum:
+ - "SUCCESS"
+ - "UNKNOWN"
+ - "PENDING"
+ - "PAYMENT_FAILURE"
+ - "PLUGIN_FAILURE"
+ - "PAYMENT_SYSTEM_OFF"
+ gatewayErrorCode:
+ type: "string"
+ gatewayErrorMsg:
+ type: "string"
+ firstPaymentReferenceId:
+ type: "string"
+ secondPaymentReferenceId:
+ type: "string"
+ properties:
+ type: "array"
+ items:
+ $ref: "#/definitions/PluginProperty"
+ auditLogs:
+ type: "array"
+ items:
+ $ref: "#/definitions/AuditLog"
+ PluginProperty:
+ type: "object"
+ properties:
+ key:
+ type: "string"
+ value:
+ type: "string"
+ isUpdatable:
+ type: "boolean"
+ PaymentMethod:
+ type: "object"
+ properties:
+ paymentMethodId:
+ type: "string"
+ format: "uuid"
+ externalKey:
+ type: "string"
+ accountId:
+ type: "string"
+ format: "uuid"
+ isDefault:
+ type: "boolean"
pluginName:
type: "string"
- pluginProperties:
- type: "array"
- items:
- $ref: "#/definitions/PluginProperty"
+ 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"
- PaymentTransaction:
+ PhasePrice:
type: "object"
properties:
- transactionId:
+ 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"
- transactionExternalKey:
+ bundleId:
type: "string"
- paymentId:
+ format: "uuid"
+ bundleExternalKey:
+ type: "string"
+ subscriptionId:
type: "string"
format: "uuid"
- description: "Associated payment id, required when notifying state transitions"
- paymentExternalKey:
+ externalKey:
type: "string"
- transactionType:
+ startDate:
+ type: "string"
+ format: "date-time"
+ productName:
+ type: "string"
+ productCategory:
type: "string"
enum:
- - "AUTHORIZE"
- - "CAPTURE"
- - "CHARGEBACK"
- - "CREDIT"
- - "PURCHASE"
- - "REFUND"
- - "VOID"
+ - "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"
- description: "Transaction amount, required except for void operations"
currency:
type: "string"
- description: "Amount currency (account currency unless specified)"
enum:
- "AED"
- "AFN"
@@ -13625,12 +13633,127 @@ definitions:
- "ZMW"
- "ZWD"
- "BTC"
- effectiveDate:
+ 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: "date-time"
- processedAmount:
+ 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:
+ type: "string"
+ format: "date"
+ amount:
type: "number"
- processedCurrency:
+ rate:
+ type: "number"
+ currency:
type: "string"
enum:
- "AED"
@@ -13798,79 +13921,17 @@ definitions:
- "ZMW"
- "ZWD"
- "BTC"
- status:
- type: "string"
- description: "Transaction status, required for state change notifications"
- enum:
- - "SUCCESS"
- - "UNKNOWN"
- - "PENDING"
- - "PAYMENT_FAILURE"
- - "PLUGIN_FAILURE"
- - "PAYMENT_SYSTEM_OFF"
- gatewayErrorCode:
- type: "string"
- gatewayErrorMsg:
- type: "string"
- firstPaymentReferenceId:
+ quantity:
+ type: "number"
+ itemDetails:
type: "string"
- secondPaymentReferenceId:
+ catalogEffectiveDate:
type: "string"
- properties:
- type: "array"
- items:
- $ref: "#/definitions/PluginProperty"
- auditLogs:
+ format: "date-time"
+ childItems:
type: "array"
items:
- $ref: "#/definitions/AuditLog"
- PluginProperty:
- type: "object"
- properties:
- key:
- type: "string"
- value:
- type: "string"
- isUpdatable:
- type: "boolean"
- CustomField:
- type: "object"
- required:
- - "name"
- - "value"
- properties:
- customFieldId:
- type: "string"
- format: "uuid"
- objectId:
- type: "string"
- format: "uuid"
- objectType:
- type: "string"
- enum:
- - "ACCOUNT"
- - "ACCOUNT_EMAIL"
- - "BLOCKING_STATES"
- - "BUNDLE"
- - "CUSTOM_FIELD"
- - "INVOICE"
- - "PAYMENT"
- - "TRANSACTION"
- - "INVOICE_ITEM"
- - "INVOICE_PAYMENT"
- - "SUBSCRIPTION"
- - "SUBSCRIPTION_EVENT"
- - "SERVICE_BROADCAST"
- - "PAYMENT_ATTEMPT"
- - "PAYMENT_METHOD"
- - "TAG"
- - "TAG_DEFINITION"
- - "TENANT"
- - "TENANT_KVS"
- name:
- type: "string"
- value:
- type: "string"
+ $ref: "#/definitions/InvoiceItem"
auditLogs:
type: "array"
items:
@@ -14097,67 +14158,6 @@ definitions:
type: "array"
items:
$ref: "#/definitions/AuditLog"
- PaymentMethod:
- type: "object"
- properties:
- paymentMethodId:
- type: "string"
- format: "uuid"
- externalKey:
- type: "string"
- accountId:
- type: "string"
- format: "uuid"
- isDefault:
- type: "boolean"
- pluginName:
- type: "string"
- pluginInfo:
- $ref: "#/definitions/PaymentMethodPluginDetail"
- auditLogs:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
- PaymentMethodPluginDetail:
- type: "object"
- properties:
- externalPaymentMethodId:
- type: "string"
- isDefaultPaymentMethod:
- type: "boolean"
- properties:
- type: "array"
- items:
- $ref: "#/definitions/PluginProperty"
- BlockingState:
- type: "object"
- properties:
- blockedId:
- type: "string"
- format: "uuid"
- stateName:
- type: "string"
- service:
- type: "string"
- isBlockChange:
- type: "boolean"
- isBlockEntitlement:
- type: "boolean"
- isBlockBilling:
- type: "boolean"
- effectiveDate:
- type: "string"
- format: "date-time"
- type:
- type: "string"
- enum:
- - "SUBSCRIPTION"
- - "SUBSCRIPTION_BUNDLE"
- - "ACCOUNT"
- auditLogs:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
AdminPayment:
type: "object"
properties:
@@ -14167,42 +14167,19 @@ definitions:
type: "string"
transactionStatus:
type: "string"
- PlanDetail:
- type: "object"
- properties:
- product:
- type: "string"
- plan:
- type: "string"
- priceList:
- type: "string"
- finalPhaseBillingPeriod:
- type: "string"
- enum:
- - "DAILY"
- - "WEEKLY"
- - "BIWEEKLY"
- - "THIRTY_DAYS"
- - "THIRTY_ONE_DAYS"
- - "SIXTY_DAYS"
- - "NINETY_DAYS"
- - "MONTHLY"
- - "BIMESTRIAL"
- - "QUARTERLY"
- - "TRIANNUAL"
- - "BIANNUAL"
- - "ANNUAL"
- - "SESQUIENNIAL"
- - "BIENNIAL"
- - "TRIENNIAL"
- - "NO_BILLING_PERIOD"
- finalPhaseRecurringPrice:
- type: "array"
- items:
- $ref: "#/definitions/Price"
- Price:
+ SimplePlan:
type: "object"
properties:
+ planId:
+ type: "string"
+ productName:
+ type: "string"
+ productCategory:
+ type: "string"
+ enum:
+ - "BASE"
+ - "ADD_ON"
+ - "STANDALONE"
currency:
type: "string"
enum:
@@ -14371,253 +14348,53 @@ definitions:
- "ZMW"
- "ZWD"
- "BTC"
- value:
+ amount:
type: "number"
- Catalog:
- type: "object"
- properties:
- name:
- type: "string"
- effectiveDate:
- type: "string"
- format: "date-time"
- currencies:
- type: "array"
- items:
- type: "string"
- enum:
- - "AED"
- - "AFN"
- - "ALL"
- - "AMD"
- - "ANG"
- - "AOA"
- - "ARS"
- - "AUD"
- - "AWG"
- - "AZN"
- - "BAM"
- - "BBD"
- - "BDT"
- - "BGN"
- - "BHD"
- - "BIF"
- - "BMD"
- - "BND"
- - "BOB"
- - "BRL"
- - "BSD"
- - "BTN"
- - "BWP"
- - "BYR"
- - "BZD"
- - "CAD"
- - "CDF"
- - "CHF"
- - "CLP"
- - "CNY"
- - "COP"
- - "CRC"
- - "CUC"
- - "CUP"
- - "CVE"
- - "CZK"
- - "DJF"
- - "DKK"
- - "DOP"
- - "DZD"
- - "EGP"
- - "ERN"
- - "ETB"
- - "EUR"
- - "FJD"
- - "FKP"
- - "GBP"
- - "GEL"
- - "GGP"
- - "GHS"
- - "GIP"
- - "GMD"
- - "GNF"
- - "GTQ"
- - "GYD"
- - "HKD"
- - "HNL"
- - "HRK"
- - "HTG"
- - "HUF"
- - "IDR"
- - "ILS"
- - "IMP"
- - "INR"
- - "IQD"
- - "IRR"
- - "ISK"
- - "JEP"
- - "JMD"
- - "JOD"
- - "JPY"
- - "KES"
- - "KGS"
- - "KHR"
- - "KMF"
- - "KPW"
- - "KRW"
- - "KWD"
- - "KYD"
- - "KZT"
- - "LAK"
- - "LBP"
- - "LKR"
- - "LRD"
- - "LSL"
- - "LTL"
- - "LVL"
- - "LYD"
- - "MAD"
- - "MDL"
- - "MGA"
- - "MKD"
- - "MMK"
- - "MNT"
- - "MOP"
- - "MRO"
- - "MUR"
- - "MVR"
- - "MWK"
- - "MXN"
- - "MYR"
- - "MZN"
- - "NAD"
- - "NGN"
- - "NIO"
- - "NOK"
- - "NPR"
- - "NZD"
- - "OMR"
- - "PAB"
- - "PEN"
- - "PGK"
- - "PHP"
- - "PKR"
- - "PLN"
- - "PYG"
- - "QAR"
- - "RON"
- - "RSD"
- - "RUB"
- - "RWF"
- - "SAR"
- - "SBD"
- - "SCR"
- - "SDG"
- - "SEK"
- - "SGD"
- - "SHP"
- - "SLL"
- - "SOS"
- - "SPL"
- - "SRD"
- - "STD"
- - "SVC"
- - "SYP"
- - "SZL"
- - "THB"
- - "TJS"
- - "TMT"
- - "TND"
- - "TOP"
- - "TRY"
- - "TTD"
- - "TVD"
- - "TWD"
- - "TZS"
- - "UAH"
- - "UGX"
- - "USD"
- - "UYU"
- - "UZS"
- - "VEF"
- - "VND"
- - "VUV"
- - "WST"
- - "XAF"
- - "XCD"
- - "XDR"
- - "XOF"
- - "XPF"
- - "YER"
- - "ZAR"
- - "ZMW"
- - "ZWD"
- - "BTC"
- units:
- type: "array"
- items:
- $ref: "#/definitions/Unit"
- products:
- type: "array"
- items:
- $ref: "#/definitions/Product"
- priceLists:
- type: "array"
- items:
- $ref: "#/definitions/PriceList"
- Duration:
- type: "object"
- properties:
- unit:
+ billingPeriod:
type: "string"
enum:
- - "DAYS"
- - "WEEKS"
- - "MONTHS"
- - "YEARS"
- - "UNLIMITED"
- number:
+ - "DAILY"
+ - "WEEKLY"
+ - "BIWEEKLY"
+ - "THIRTY_DAYS"
+ - "THIRTY_ONE_DAYS"
+ - "SIXTY_DAYS"
+ - "NINETY_DAYS"
+ - "MONTHLY"
+ - "BIMESTRIAL"
+ - "QUARTERLY"
+ - "TRIANNUAL"
+ - "BIANNUAL"
+ - "ANNUAL"
+ - "SESQUIENNIAL"
+ - "BIENNIAL"
+ - "TRIENNIAL"
+ - "NO_BILLING_PERIOD"
+ trialLength:
type: "integer"
format: "int32"
- Limit:
- type: "object"
- properties:
- unit:
- type: "string"
- max:
- type: "string"
- min:
- type: "string"
- Phase:
- type: "object"
- properties:
- type:
+ trialTimeUnit:
type: "string"
- prices:
- type: "array"
- items:
- $ref: "#/definitions/Price"
- fixedPrices:
- type: "array"
- items:
- $ref: "#/definitions/Price"
- duration:
- $ref: "#/definitions/Duration"
- usages:
+ enum:
+ - "DAYS"
+ - "WEEKS"
+ - "MONTHS"
+ - "YEARS"
+ - "UNLIMITED"
+ availableBaseProducts:
type: "array"
items:
- $ref: "#/definitions/Usage"
- Plan:
+ type: "string"
+ PlanDetail:
type: "object"
properties:
- name:
+ product:
type: "string"
- prettyName:
+ plan:
type: "string"
- recurringBillingMode:
+ priceList:
type: "string"
- enum:
- - "IN_ADVANCE"
- - "IN_ARREAR"
- billingPeriod:
+ finalPhaseBillingPeriod:
type: "string"
enum:
- "DAILY"
@@ -14637,113 +14414,13 @@ definitions:
- "BIENNIAL"
- "TRIENNIAL"
- "NO_BILLING_PERIOD"
- phases:
- type: "array"
- items:
- $ref: "#/definitions/Phase"
- PriceList:
- type: "object"
- properties:
- name:
- type: "string"
- plans:
- type: "array"
- items:
- type: "string"
- Product:
- type: "object"
- properties:
- type:
- type: "string"
- name:
- type: "string"
- prettyName:
- type: "string"
- plans:
- type: "array"
- items:
- $ref: "#/definitions/Plan"
- included:
- type: "array"
- items:
- type: "string"
- available:
- type: "array"
- items:
- type: "string"
- Tier:
- type: "object"
- properties:
- limits:
- type: "array"
- items:
- $ref: "#/definitions/Limit"
- fixedPrice:
- type: "array"
- items:
- $ref: "#/definitions/Price"
- recurringPrice:
- type: "array"
- items:
- $ref: "#/definitions/Price"
- blocks:
- type: "array"
- items:
- $ref: "#/definitions/TieredBlock"
- TieredBlock:
- type: "object"
- properties:
- unit:
- type: "string"
- size:
- type: "string"
- max:
- type: "string"
- prices:
+ finalPhaseRecurringPrice:
type: "array"
items:
$ref: "#/definitions/Price"
- Unit:
- type: "object"
- properties:
- name:
- type: "string"
- prettyName:
- type: "string"
- Usage:
- type: "object"
- properties:
- billingPeriod:
- type: "string"
- tiers:
- type: "array"
- items:
- $ref: "#/definitions/Tier"
- CatalogValidation:
- type: "object"
- properties:
- catalogValidationErrors:
- type: "array"
- items:
- $ref: "#/definitions/CatalogValidationError"
- CatalogValidationError:
- type: "object"
- properties:
- errorDescription:
- type: "string"
- SimplePlan:
+ Price:
type: "object"
properties:
- planId:
- type: "string"
- productName:
- type: "string"
- productCategory:
- type: "string"
- enum:
- - "BASE"
- - "ADD_ON"
- - "STANDALONE"
currency:
type: "string"
enum:
@@ -14912,8 +14589,252 @@ definitions:
- "ZMW"
- "ZWD"
- "BTC"
- amount:
+ value:
type: "number"
+ Catalog:
+ type: "object"
+ properties:
+ name:
+ type: "string"
+ effectiveDate:
+ type: "string"
+ format: "date-time"
+ currencies:
+ type: "array"
+ items:
+ type: "string"
+ enum:
+ - "AED"
+ - "AFN"
+ - "ALL"
+ - "AMD"
+ - "ANG"
+ - "AOA"
+ - "ARS"
+ - "AUD"
+ - "AWG"
+ - "AZN"
+ - "BAM"
+ - "BBD"
+ - "BDT"
+ - "BGN"
+ - "BHD"
+ - "BIF"
+ - "BMD"
+ - "BND"
+ - "BOB"
+ - "BRL"
+ - "BSD"
+ - "BTN"
+ - "BWP"
+ - "BYR"
+ - "BZD"
+ - "CAD"
+ - "CDF"
+ - "CHF"
+ - "CLP"
+ - "CNY"
+ - "COP"
+ - "CRC"
+ - "CUC"
+ - "CUP"
+ - "CVE"
+ - "CZK"
+ - "DJF"
+ - "DKK"
+ - "DOP"
+ - "DZD"
+ - "EGP"
+ - "ERN"
+ - "ETB"
+ - "EUR"
+ - "FJD"
+ - "FKP"
+ - "GBP"
+ - "GEL"
+ - "GGP"
+ - "GHS"
+ - "GIP"
+ - "GMD"
+ - "GNF"
+ - "GTQ"
+ - "GYD"
+ - "HKD"
+ - "HNL"
+ - "HRK"
+ - "HTG"
+ - "HUF"
+ - "IDR"
+ - "ILS"
+ - "IMP"
+ - "INR"
+ - "IQD"
+ - "IRR"
+ - "ISK"
+ - "JEP"
+ - "JMD"
+ - "JOD"
+ - "JPY"
+ - "KES"
+ - "KGS"
+ - "KHR"
+ - "KMF"
+ - "KPW"
+ - "KRW"
+ - "KWD"
+ - "KYD"
+ - "KZT"
+ - "LAK"
+ - "LBP"
+ - "LKR"
+ - "LRD"
+ - "LSL"
+ - "LTL"
+ - "LVL"
+ - "LYD"
+ - "MAD"
+ - "MDL"
+ - "MGA"
+ - "MKD"
+ - "MMK"
+ - "MNT"
+ - "MOP"
+ - "MRO"
+ - "MUR"
+ - "MVR"
+ - "MWK"
+ - "MXN"
+ - "MYR"
+ - "MZN"
+ - "NAD"
+ - "NGN"
+ - "NIO"
+ - "NOK"
+ - "NPR"
+ - "NZD"
+ - "OMR"
+ - "PAB"
+ - "PEN"
+ - "PGK"
+ - "PHP"
+ - "PKR"
+ - "PLN"
+ - "PYG"
+ - "QAR"
+ - "RON"
+ - "RSD"
+ - "RUB"
+ - "RWF"
+ - "SAR"
+ - "SBD"
+ - "SCR"
+ - "SDG"
+ - "SEK"
+ - "SGD"
+ - "SHP"
+ - "SLL"
+ - "SOS"
+ - "SPL"
+ - "SRD"
+ - "STD"
+ - "SVC"
+ - "SYP"
+ - "SZL"
+ - "THB"
+ - "TJS"
+ - "TMT"
+ - "TND"
+ - "TOP"
+ - "TRY"
+ - "TTD"
+ - "TVD"
+ - "TWD"
+ - "TZS"
+ - "UAH"
+ - "UGX"
+ - "USD"
+ - "UYU"
+ - "UZS"
+ - "VEF"
+ - "VND"
+ - "VUV"
+ - "WST"
+ - "XAF"
+ - "XCD"
+ - "XDR"
+ - "XOF"
+ - "XPF"
+ - "YER"
+ - "ZAR"
+ - "ZMW"
+ - "ZWD"
+ - "BTC"
+ units:
+ type: "array"
+ items:
+ $ref: "#/definitions/Unit"
+ products:
+ type: "array"
+ items:
+ $ref: "#/definitions/Product"
+ priceLists:
+ type: "array"
+ items:
+ $ref: "#/definitions/PriceList"
+ Duration:
+ type: "object"
+ properties:
+ unit:
+ type: "string"
+ enum:
+ - "DAYS"
+ - "WEEKS"
+ - "MONTHS"
+ - "YEARS"
+ - "UNLIMITED"
+ number:
+ type: "integer"
+ format: "int32"
+ Limit:
+ type: "object"
+ properties:
+ unit:
+ type: "string"
+ max:
+ type: "string"
+ min:
+ type: "string"
+ Phase:
+ type: "object"
+ properties:
+ type:
+ type: "string"
+ prices:
+ type: "array"
+ items:
+ $ref: "#/definitions/Price"
+ fixedPrices:
+ type: "array"
+ items:
+ $ref: "#/definitions/Price"
+ duration:
+ $ref: "#/definitions/Duration"
+ usages:
+ type: "array"
+ items:
+ $ref: "#/definitions/Usage"
+ Plan:
+ type: "object"
+ properties:
+ name:
+ type: "string"
+ prettyName:
+ type: "string"
+ recurringBillingMode:
+ type: "string"
+ enum:
+ - "IN_ADVANCE"
+ - "IN_ARREAR"
billingPeriod:
type: "string"
enum:
@@ -14934,21 +14855,100 @@ definitions:
- "BIENNIAL"
- "TRIENNIAL"
- "NO_BILLING_PERIOD"
- trialLength:
- type: "integer"
- format: "int32"
- trialTimeUnit:
+ phases:
+ type: "array"
+ items:
+ $ref: "#/definitions/Phase"
+ PriceList:
+ type: "object"
+ properties:
+ name:
type: "string"
- enum:
- - "DAYS"
- - "WEEKS"
- - "MONTHS"
- - "YEARS"
- - "UNLIMITED"
- availableBaseProducts:
+ plans:
+ type: "array"
+ items:
+ type: "string"
+ Product:
+ type: "object"
+ properties:
+ type:
+ type: "string"
+ name:
+ type: "string"
+ prettyName:
+ type: "string"
+ plans:
+ type: "array"
+ items:
+ $ref: "#/definitions/Plan"
+ included:
type: "array"
items:
type: "string"
+ available:
+ type: "array"
+ items:
+ type: "string"
+ Tier:
+ type: "object"
+ properties:
+ limits:
+ type: "array"
+ items:
+ $ref: "#/definitions/Limit"
+ fixedPrice:
+ type: "array"
+ items:
+ $ref: "#/definitions/Price"
+ recurringPrice:
+ type: "array"
+ items:
+ $ref: "#/definitions/Price"
+ blocks:
+ type: "array"
+ items:
+ $ref: "#/definitions/TieredBlock"
+ TieredBlock:
+ type: "object"
+ properties:
+ unit:
+ type: "string"
+ size:
+ type: "string"
+ max:
+ type: "string"
+ prices:
+ type: "array"
+ items:
+ $ref: "#/definitions/Price"
+ Unit:
+ type: "object"
+ properties:
+ name:
+ type: "string"
+ prettyName:
+ type: "string"
+ Usage:
+ type: "object"
+ properties:
+ billingPeriod:
+ type: "string"
+ tiers:
+ type: "array"
+ items:
+ $ref: "#/definitions/Tier"
+ CatalogValidation:
+ type: "object"
+ properties:
+ catalogValidationErrors:
+ type: "array"
+ items:
+ $ref: "#/definitions/CatalogValidationError"
+ CatalogValidationError:
+ type: "object"
+ properties:
+ errorDescription:
+ type: "string"
InvoicePaymentTransaction:
type: "object"
properties:
@@ -15607,6 +15607,13 @@ definitions:
type: "array"
items:
$ref: "#/definitions/AuditLog"
+ HostedPaymentPageFields:
+ type: "object"
+ properties:
+ formFields:
+ type: "array"
+ items:
+ $ref: "#/definitions/PluginProperty"
ComboHostedPaymentPage:
type: "object"
properties:
@@ -15624,13 +15631,6 @@ definitions:
type: "array"
items:
$ref: "#/definitions/AuditLog"
- HostedPaymentPageFields:
- type: "object"
- properties:
- formFields:
- type: "array"
- items:
- $ref: "#/definitions/PluginProperty"
ComboPaymentTransaction:
type: "object"
properties:
@@ -15759,19 +15759,6 @@ definitions:
type: "array"
items:
$ref: "#/definitions/AuditLog"
- TenantKeyValue:
- type: "object"
- properties:
- key:
- type: "string"
- values:
- type: "array"
- items:
- type: "string"
- auditLogs:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
Tenant:
type: "object"
required:
@@ -15791,6 +15778,19 @@ definitions:
type: "array"
items:
$ref: "#/definitions/AuditLog"
+ TenantKeyValue:
+ type: "object"
+ properties:
+ key:
+ type: "string"
+ values:
+ type: "array"
+ items:
+ type: "string"
+ auditLogs:
+ type: "array"
+ items:
+ $ref: "#/definitions/AuditLog"
RolledUpUnit:
type: "object"
properties:
diff --git a/pom.xml b/pom.xml
index 7dcf5f7..27731d3 100644
--- a/pom.xml
+++ b/pom.xml
@@ -25,7 +25,7 @@
0.146.76
killbill-client-java
- 1.3.15-SNAPSHOT
+ 1.4.0-SNAPSHOT
jar
Kill Bill Client Java
Kill Bill Java client library
@@ -59,7 +59,8 @@
com.fasterxml.jackson.datatype
- jackson-datatype-joda
+ jackson-datatype-jsr310
+ ${jackson.version}
com.github.spotbugs
@@ -69,10 +70,6 @@
com.google.code.findbugs
jsr305
-
- joda-time
- joda-time
-
mysql
mysql-connector-java
@@ -125,8 +122,8 @@
-
-
+
+
MANIFEST.MF
diff --git a/src/main/java/org/killbill/billing/client/KillBillHttpClient.java b/src/main/java/org/killbill/billing/client/KillBillHttpClient.java
index 0a034b4..4f70bc3 100644
--- a/src/main/java/org/killbill/billing/client/KillBillHttpClient.java
+++ b/src/main/java/org/killbill/billing/client/KillBillHttpClient.java
@@ -53,7 +53,8 @@
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.datatype.joda.JodaModule;
+import com.fasterxml.jackson.databind.SerializationFeature;
+import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
public class KillBillHttpClient implements Closeable {
@@ -172,7 +173,8 @@ public KillBillHttpClient(final String kbServerUrl,
}
mapper = new ObjectMapper();
- mapper.registerModule(new JodaModule());
+ mapper.registerModule(new JavaTimeModule());
+ mapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
}
public KillBillHttpClient(final String kbServerUrl, final String username, final String password, final String apiKey, final String apiSecret) {
diff --git a/src/main/java/org/killbill/billing/client/api/gen/AccountApi.java b/src/main/java/org/killbill/billing/client/api/gen/AccountApi.java
index c4eece2..6aec767 100644
--- a/src/main/java/org/killbill/billing/client/api/gen/AccountApi.java
+++ b/src/main/java/org/killbill/billing/client/api/gen/AccountApi.java
@@ -32,7 +32,7 @@
import org.killbill.billing.client.model.gen.CustomField;
import org.killbill.billing.client.model.gen.Invoice;
import org.killbill.billing.client.model.gen.InvoicePayment;
-import org.joda.time.LocalDate;
+import java.time.LocalDate;
import org.killbill.billing.client.model.gen.OverdueState;
import org.killbill.billing.client.model.gen.Payment;
import org.killbill.billing.client.model.gen.PaymentMethod;
@@ -56,6 +56,8 @@
import org.killbill.billing.client.model.PaymentMethods;
import org.killbill.billing.client.model.Payments;
+import java.time.format.DateTimeFormatter;
+
import org.killbill.billing.client.Converter;
import org.killbill.billing.client.KillBillClientException;
import org.killbill.billing.client.KillBillHttpClient;
diff --git a/src/main/java/org/killbill/billing/client/api/gen/AdminApi.java b/src/main/java/org/killbill/billing/client/api/gen/AdminApi.java
index ee3b9e2..38cd1c1 100644
--- a/src/main/java/org/killbill/billing/client/api/gen/AdminApi.java
+++ b/src/main/java/org/killbill/billing/client/api/gen/AdminApi.java
@@ -29,6 +29,8 @@
import java.net.http.HttpResponse;
import java.util.Map;
+import java.time.format.DateTimeFormatter;
+
import org.killbill.billing.client.Converter;
import org.killbill.billing.client.KillBillClientException;
import org.killbill.billing.client.KillBillHttpClient;
diff --git a/src/main/java/org/killbill/billing/client/api/gen/BundleApi.java b/src/main/java/org/killbill/billing/client/api/gen/BundleApi.java
index df42d43..48b22bb 100644
--- a/src/main/java/org/killbill/billing/client/api/gen/BundleApi.java
+++ b/src/main/java/org/killbill/billing/client/api/gen/BundleApi.java
@@ -26,13 +26,13 @@
import org.killbill.billing.client.model.gen.BlockingState;
import org.killbill.billing.client.model.gen.Bundle;
import org.killbill.billing.client.model.gen.CustomField;
-import org.joda.time.LocalDate;
+import java.time.LocalDate;
import org.killbill.billing.client.model.gen.Tag;
import java.util.UUID;
import org.killbill.billing.client.model.BlockingStates;
import java.util.List;
import java.util.Map;
-import org.joda.time.DateTime;
+import java.time.ZonedDateTime;
import org.killbill.billing.client.model.CustomFields;
import org.killbill.billing.client.model.Tags;
import org.killbill.billing.util.api.AuditLevel;
@@ -41,6 +41,8 @@
import org.killbill.billing.catalog.api.BillingActionPolicy;
import org.killbill.billing.entitlement.api.BcdTransfer;
+import java.time.format.DateTimeFormatter;
+
import org.killbill.billing.client.Converter;
import org.killbill.billing.client.KillBillClientException;
import org.killbill.billing.client.KillBillHttpClient;
@@ -94,7 +96,7 @@ public BlockingStates addBundleBlockingState(final UUID bundleId, final Blocking
return httpClient.doPost(uri, body, BlockingStates.class, requestOptions);
}
- public BlockingStates addBundleBlockingState(final UUID bundleId, final BlockingState body, final DateTime requestedDate, final Map pluginProperty, final RequestOptions inputOptions) throws KillBillClientException {
+ public BlockingStates addBundleBlockingState(final UUID bundleId, final BlockingState body, final ZonedDateTime requestedDate, final Map pluginProperty, final RequestOptions inputOptions) throws KillBillClientException {
Preconditions.checkNotNull(bundleId, "Missing the required parameter 'bundleId' when calling addBundleBlockingState");
Preconditions.checkNotNull(body, "Missing the required parameter 'body' when calling addBundleBlockingState");
@@ -103,7 +105,7 @@ public BlockingStates addBundleBlockingState(final UUID bundleId, final Blocking
final Multimap queryParams = new TreeMapSetMultimap<>(inputOptions.getQueryParams());
if (requestedDate != null) {
- queryParams.put("requestedDate", String.valueOf(requestedDate));
+ queryParams.put("requestedDate", DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(requestedDate));
}
if (pluginProperty != null) {
queryParams.putAll("pluginProperty", Converter.convertPluginPropertyMap(pluginProperty));
diff --git a/src/main/java/org/killbill/billing/client/api/gen/CatalogApi.java b/src/main/java/org/killbill/billing/client/api/gen/CatalogApi.java
index fdc5e71..e792108 100644
--- a/src/main/java/org/killbill/billing/client/api/gen/CatalogApi.java
+++ b/src/main/java/org/killbill/billing/client/api/gen/CatalogApi.java
@@ -24,8 +24,7 @@
import org.killbill.billing.client.model.gen.Catalog;
import org.killbill.billing.client.model.gen.CatalogValidation;
-import org.joda.time.DateTime;
-import org.joda.time.LocalDate;
+import java.time.LocalDate;
import org.killbill.billing.client.model.gen.Phase;
import org.killbill.billing.client.model.gen.Plan;
import org.killbill.billing.client.model.gen.PlanDetail;
@@ -33,11 +32,14 @@
import org.killbill.billing.client.model.gen.Product;
import org.killbill.billing.client.model.gen.SimplePlan;
import java.util.UUID;
+import java.time.ZonedDateTime;
import org.killbill.billing.client.model.PlanDetails;
import java.util.List;
import org.killbill.billing.client.model.Catalogs;
import org.killbill.billing.client.model.DateTimes;
+import java.time.format.DateTimeFormatter;
+
import org.killbill.billing.client.Converter;
import org.killbill.billing.client.KillBillClientException;
import org.killbill.billing.client.KillBillHttpClient;
@@ -134,13 +136,13 @@ public PlanDetails getAvailableBasePlans(final UUID accountId, final RequestOpti
return httpClient.doGet(uri, PlanDetails.class, requestOptions);
}
- public Catalogs getCatalogJson(final DateTime requestedDate, final UUID accountId, final RequestOptions inputOptions) throws KillBillClientException {
+ public Catalogs getCatalogJson(final ZonedDateTime requestedDate, final UUID accountId, final RequestOptions inputOptions) throws KillBillClientException {
final String uri = "/1.0/kb/catalog";
final Multimap queryParams = new TreeMapSetMultimap<>(inputOptions.getQueryParams());
if (requestedDate != null) {
- queryParams.put("requestedDate", String.valueOf(requestedDate));
+ queryParams.put("requestedDate", DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(requestedDate));
}
if (accountId != null) {
queryParams.put("accountId", String.valueOf(accountId));
@@ -171,13 +173,13 @@ public DateTimes getCatalogVersions(final UUID accountId, final RequestOptions i
return httpClient.doGet(uri, DateTimes.class, requestOptions);
}
- public String getCatalogXml(final DateTime requestedDate, final UUID accountId, final RequestOptions inputOptions) throws KillBillClientException {
+ public String getCatalogXml(final ZonedDateTime requestedDate, final UUID accountId, final RequestOptions inputOptions) throws KillBillClientException {
final String uri = "/1.0/kb/catalog/xml";
final Multimap queryParams = new TreeMapSetMultimap<>(inputOptions.getQueryParams());
if (requestedDate != null) {
- queryParams.put("requestedDate", String.valueOf(requestedDate));
+ queryParams.put("requestedDate", DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(requestedDate));
}
if (accountId != null) {
queryParams.put("accountId", String.valueOf(accountId));
diff --git a/src/main/java/org/killbill/billing/client/api/gen/CreditApi.java b/src/main/java/org/killbill/billing/client/api/gen/CreditApi.java
index 110c17b..0334133 100644
--- a/src/main/java/org/killbill/billing/client/api/gen/CreditApi.java
+++ b/src/main/java/org/killbill/billing/client/api/gen/CreditApi.java
@@ -23,12 +23,14 @@
import java.util.Objects;
import org.killbill.billing.client.model.gen.InvoiceItem;
-import org.joda.time.LocalDate;
+import java.time.LocalDate;
import java.util.UUID;
import org.killbill.billing.client.model.InvoiceItems;
import java.util.List;
import java.util.Map;
+import java.time.format.DateTimeFormatter;
+
import org.killbill.billing.client.Converter;
import org.killbill.billing.client.KillBillClientException;
import org.killbill.billing.client.KillBillHttpClient;
diff --git a/src/main/java/org/killbill/billing/client/api/gen/CustomFieldApi.java b/src/main/java/org/killbill/billing/client/api/gen/CustomFieldApi.java
index 5b60136..4001a2d 100644
--- a/src/main/java/org/killbill/billing/client/api/gen/CustomFieldApi.java
+++ b/src/main/java/org/killbill/billing/client/api/gen/CustomFieldApi.java
@@ -30,6 +30,8 @@
import org.killbill.billing.client.model.CustomFields;
import org.killbill.billing.util.api.AuditLevel;
+import java.time.format.DateTimeFormatter;
+
import org.killbill.billing.client.Converter;
import org.killbill.billing.client.KillBillClientException;
import org.killbill.billing.client.KillBillHttpClient;
diff --git a/src/main/java/org/killbill/billing/client/api/gen/ExportApi.java b/src/main/java/org/killbill/billing/client/api/gen/ExportApi.java
index 416ca90..8b52fd4 100644
--- a/src/main/java/org/killbill/billing/client/api/gen/ExportApi.java
+++ b/src/main/java/org/killbill/billing/client/api/gen/ExportApi.java
@@ -27,6 +27,8 @@
import java.io.OutputStream;
import java.net.http.HttpResponse;
+import java.time.format.DateTimeFormatter;
+
import org.killbill.billing.client.Converter;
import org.killbill.billing.client.KillBillClientException;
import org.killbill.billing.client.KillBillHttpClient;
diff --git a/src/main/java/org/killbill/billing/client/api/gen/InvoiceApi.java b/src/main/java/org/killbill/billing/client/api/gen/InvoiceApi.java
index d2bbde5..a85e905 100644
--- a/src/main/java/org/killbill/billing/client/api/gen/InvoiceApi.java
+++ b/src/main/java/org/killbill/billing/client/api/gen/InvoiceApi.java
@@ -28,7 +28,7 @@
import org.killbill.billing.client.model.gen.InvoiceDryRun;
import org.killbill.billing.client.model.gen.InvoiceItem;
import org.killbill.billing.client.model.gen.InvoicePayment;
-import org.joda.time.LocalDate;
+import java.time.LocalDate;
import org.killbill.billing.client.model.gen.Tag;
import java.util.UUID;
import java.util.Map;
@@ -41,6 +41,8 @@
import org.killbill.billing.client.model.AuditLogs;
import org.killbill.billing.client.model.InvoicePayments;
+import java.time.format.DateTimeFormatter;
+
import org.killbill.billing.client.Converter;
import org.killbill.billing.client.KillBillClientException;
import org.killbill.billing.client.KillBillHttpClient;
diff --git a/src/main/java/org/killbill/billing/client/api/gen/InvoiceItemApi.java b/src/main/java/org/killbill/billing/client/api/gen/InvoiceItemApi.java
index 484dabf..96e3300 100644
--- a/src/main/java/org/killbill/billing/client/api/gen/InvoiceItemApi.java
+++ b/src/main/java/org/killbill/billing/client/api/gen/InvoiceItemApi.java
@@ -32,6 +32,8 @@
import org.killbill.billing.client.model.AuditLogs;
import org.killbill.billing.util.api.AuditLevel;
+import java.time.format.DateTimeFormatter;
+
import org.killbill.billing.client.Converter;
import org.killbill.billing.client.KillBillClientException;
import org.killbill.billing.client.KillBillHttpClient;
diff --git a/src/main/java/org/killbill/billing/client/api/gen/InvoicePaymentApi.java b/src/main/java/org/killbill/billing/client/api/gen/InvoicePaymentApi.java
index a377876..53c73a7 100644
--- a/src/main/java/org/killbill/billing/client/api/gen/InvoicePaymentApi.java
+++ b/src/main/java/org/killbill/billing/client/api/gen/InvoicePaymentApi.java
@@ -36,6 +36,8 @@
import org.killbill.billing.util.api.AuditLevel;
import org.killbill.billing.client.model.AuditLogs;
+import java.time.format.DateTimeFormatter;
+
import org.killbill.billing.client.Converter;
import org.killbill.billing.client.KillBillClientException;
import org.killbill.billing.client.KillBillHttpClient;
diff --git a/src/main/java/org/killbill/billing/client/api/gen/NodesInfoApi.java b/src/main/java/org/killbill/billing/client/api/gen/NodesInfoApi.java
index 46fd7e3..2d3385d 100644
--- a/src/main/java/org/killbill/billing/client/api/gen/NodesInfoApi.java
+++ b/src/main/java/org/killbill/billing/client/api/gen/NodesInfoApi.java
@@ -27,6 +27,8 @@
import org.killbill.billing.client.model.NodeInfos;
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;
diff --git a/src/main/java/org/killbill/billing/client/api/gen/OverdueApi.java b/src/main/java/org/killbill/billing/client/api/gen/OverdueApi.java
index 4588e8e..592685c 100644
--- a/src/main/java/org/killbill/billing/client/api/gen/OverdueApi.java
+++ b/src/main/java/org/killbill/billing/client/api/gen/OverdueApi.java
@@ -24,6 +24,8 @@
import org.killbill.billing.client.model.gen.Overdue;
+import java.time.format.DateTimeFormatter;
+
import org.killbill.billing.client.Converter;
import org.killbill.billing.client.KillBillClientException;
import org.killbill.billing.client.KillBillHttpClient;
diff --git a/src/main/java/org/killbill/billing/client/api/gen/PaymentApi.java b/src/main/java/org/killbill/billing/client/api/gen/PaymentApi.java
index 975d963..9a5c10a 100644
--- a/src/main/java/org/killbill/billing/client/api/gen/PaymentApi.java
+++ b/src/main/java/org/killbill/billing/client/api/gen/PaymentApi.java
@@ -37,6 +37,8 @@
import org.killbill.billing.client.model.AuditLogs;
import org.killbill.billing.client.model.Payments;
+import java.time.format.DateTimeFormatter;
+
import org.killbill.billing.client.Converter;
import org.killbill.billing.client.KillBillClientException;
import org.killbill.billing.client.KillBillHttpClient;
diff --git a/src/main/java/org/killbill/billing/client/api/gen/PaymentGatewayApi.java b/src/main/java/org/killbill/billing/client/api/gen/PaymentGatewayApi.java
index 5e44e2b..b1cb5eb 100644
--- a/src/main/java/org/killbill/billing/client/api/gen/PaymentGatewayApi.java
+++ b/src/main/java/org/killbill/billing/client/api/gen/PaymentGatewayApi.java
@@ -29,6 +29,8 @@
import java.util.List;
import java.util.Map;
+import java.time.format.DateTimeFormatter;
+
import org.killbill.billing.client.Converter;
import org.killbill.billing.client.KillBillClientException;
import org.killbill.billing.client.KillBillHttpClient;
diff --git a/src/main/java/org/killbill/billing/client/api/gen/PaymentMethodApi.java b/src/main/java/org/killbill/billing/client/api/gen/PaymentMethodApi.java
index acf7522..2f5b11e 100644
--- a/src/main/java/org/killbill/billing/client/api/gen/PaymentMethodApi.java
+++ b/src/main/java/org/killbill/billing/client/api/gen/PaymentMethodApi.java
@@ -33,6 +33,8 @@
import org.killbill.billing.client.model.AuditLogs;
import org.killbill.billing.client.model.PaymentMethods;
+import java.time.format.DateTimeFormatter;
+
import org.killbill.billing.client.Converter;
import org.killbill.billing.client.KillBillClientException;
import org.killbill.billing.client.KillBillHttpClient;
diff --git a/src/main/java/org/killbill/billing/client/api/gen/PaymentTransactionApi.java b/src/main/java/org/killbill/billing/client/api/gen/PaymentTransactionApi.java
index 2490842..0ed7912 100644
--- a/src/main/java/org/killbill/billing/client/api/gen/PaymentTransactionApi.java
+++ b/src/main/java/org/killbill/billing/client/api/gen/PaymentTransactionApi.java
@@ -35,6 +35,8 @@
import org.killbill.billing.util.api.AuditLevel;
import org.killbill.billing.client.model.AuditLogs;
+import java.time.format.DateTimeFormatter;
+
import org.killbill.billing.client.Converter;
import org.killbill.billing.client.KillBillClientException;
import org.killbill.billing.client.KillBillHttpClient;
diff --git a/src/main/java/org/killbill/billing/client/api/gen/PluginInfoApi.java b/src/main/java/org/killbill/billing/client/api/gen/PluginInfoApi.java
index 1d75e5b..dfbaf8b 100644
--- a/src/main/java/org/killbill/billing/client/api/gen/PluginInfoApi.java
+++ b/src/main/java/org/killbill/billing/client/api/gen/PluginInfoApi.java
@@ -26,6 +26,8 @@
import org.killbill.billing.client.model.PluginInfos;
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;
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 3a2ec23..1c425db 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
@@ -28,6 +28,8 @@
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;
diff --git a/src/main/java/org/killbill/billing/client/api/gen/SubscriptionApi.java b/src/main/java/org/killbill/billing/client/api/gen/SubscriptionApi.java
index ee86d7f..34f730c 100644
--- a/src/main/java/org/killbill/billing/client/api/gen/SubscriptionApi.java
+++ b/src/main/java/org/killbill/billing/client/api/gen/SubscriptionApi.java
@@ -27,14 +27,14 @@
import org.killbill.billing.client.model.gen.BulkSubscriptionsBundle;
import org.killbill.billing.client.model.gen.Bundle;
import org.killbill.billing.client.model.gen.CustomField;
-import org.joda.time.LocalDate;
+import java.time.LocalDate;
import org.killbill.billing.client.model.gen.Subscription;
import org.killbill.billing.client.model.gen.Tag;
import java.util.UUID;
import org.killbill.billing.client.model.BlockingStates;
import java.util.List;
import java.util.Map;
-import org.joda.time.DateTime;
+import java.time.ZonedDateTime;
import org.killbill.billing.entitlement.api.Entitlement.EntitlementActionPolicy;
import org.killbill.billing.catalog.api.BillingActionPolicy;
import org.killbill.billing.client.model.CustomFields;
@@ -45,6 +45,8 @@
import org.killbill.billing.client.model.AuditLogs;
import org.killbill.billing.client.model.Tags;
+import java.time.format.DateTimeFormatter;
+
import org.killbill.billing.client.Converter;
import org.killbill.billing.client.KillBillClientException;
import org.killbill.billing.client.KillBillHttpClient;
@@ -98,7 +100,7 @@ public BlockingStates addSubscriptionBlockingState(final UUID subscriptionId, fi
return httpClient.doPost(uri, body, BlockingStates.class, requestOptions);
}
- public BlockingStates addSubscriptionBlockingState(final UUID subscriptionId, final BlockingState body, final DateTime requestedDate, final Map pluginProperty, final RequestOptions inputOptions) throws KillBillClientException {
+ public BlockingStates addSubscriptionBlockingState(final UUID subscriptionId, final BlockingState body, final ZonedDateTime requestedDate, final Map pluginProperty, final RequestOptions inputOptions) throws KillBillClientException {
Preconditions.checkNotNull(subscriptionId, "Missing the required parameter 'subscriptionId' when calling addSubscriptionBlockingState");
Preconditions.checkNotNull(body, "Missing the required parameter 'body' when calling addSubscriptionBlockingState");
@@ -107,7 +109,7 @@ public BlockingStates addSubscriptionBlockingState(final UUID subscriptionId, fi
final Multimap queryParams = new TreeMapSetMultimap<>(inputOptions.getQueryParams());
if (requestedDate != null) {
- queryParams.put("requestedDate", String.valueOf(requestedDate));
+ queryParams.put("requestedDate", DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(requestedDate));
}
if (pluginProperty != null) {
queryParams.putAll("pluginProperty", Converter.convertPluginPropertyMap(pluginProperty));
@@ -165,12 +167,12 @@ public void cancelSubscriptionPlan(final UUID subscriptionId, final LocalDate re
httpClient.doDelete(uri, requestOptions);
}
- public void cancelSubscriptionPlan(final UUID subscriptionId, final DateTime requestedDate, final EntitlementActionPolicy entitlementPolicy, final BillingActionPolicy billingPolicy, final Map pluginProperty, final RequestOptions inputOptions) throws KillBillClientException {
+ public void cancelSubscriptionPlan(final UUID subscriptionId, final ZonedDateTime requestedDate, final EntitlementActionPolicy entitlementPolicy, final BillingActionPolicy billingPolicy, final Map pluginProperty, final RequestOptions inputOptions) throws KillBillClientException {
cancelSubscriptionPlan(subscriptionId, requestedDate, Boolean.valueOf(false), Long.valueOf(5), entitlementPolicy, billingPolicy, Boolean.valueOf(false), pluginProperty, inputOptions);
}
- public void cancelSubscriptionPlan(final UUID subscriptionId, final DateTime requestedDate, final Boolean callCompletion, final Long callTimeoutSec, final EntitlementActionPolicy entitlementPolicy, final BillingActionPolicy billingPolicy, final Boolean useRequestedDateForBilling, final Map pluginProperty, final RequestOptions inputOptions) throws KillBillClientException {
+ public void cancelSubscriptionPlan(final UUID subscriptionId, final ZonedDateTime requestedDate, final Boolean callCompletion, final Long callTimeoutSec, final EntitlementActionPolicy entitlementPolicy, final BillingActionPolicy billingPolicy, final Boolean useRequestedDateForBilling, final Map pluginProperty, final RequestOptions inputOptions) throws KillBillClientException {
Preconditions.checkNotNull(subscriptionId, "Missing the required parameter 'subscriptionId' when calling cancelSubscriptionPlan");
final String uri = "/1.0/kb/subscriptions/{subscriptionId}"
@@ -178,7 +180,7 @@ public void cancelSubscriptionPlan(final UUID subscriptionId, final DateTime req
final Multimap queryParams = new TreeMapSetMultimap<>(inputOptions.getQueryParams());
if (requestedDate != null) {
- queryParams.put("requestedDate", String.valueOf(requestedDate));
+ queryParams.put("requestedDate", DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(requestedDate));
}
if (callCompletion != null) {
queryParams.put("callCompletion", String.valueOf(callCompletion));
@@ -244,11 +246,11 @@ public void changeSubscriptionPlan(final UUID subscriptionId, final Subscription
httpClient.doPut(uri, body, requestOptions);
}
- public void changeSubscriptionPlan(final UUID subscriptionId, final Subscription body, final DateTime requestedDate, final BillingActionPolicy billingPolicy, final Map pluginProperty, final RequestOptions inputOptions) throws KillBillClientException {
+ public void changeSubscriptionPlan(final UUID subscriptionId, final Subscription body, final ZonedDateTime requestedDate, final BillingActionPolicy billingPolicy, final Map pluginProperty, final RequestOptions inputOptions) throws KillBillClientException {
changeSubscriptionPlan(subscriptionId, body, requestedDate, Boolean.valueOf(false), Long.valueOf(3), billingPolicy, pluginProperty, inputOptions);
}
- public void changeSubscriptionPlan(final UUID subscriptionId, final Subscription body, final DateTime requestedDate, final Boolean callCompletion, final Long callTimeoutSec, final BillingActionPolicy billingPolicy, final Map pluginProperty, final RequestOptions inputOptions) throws KillBillClientException {
+ public void changeSubscriptionPlan(final UUID subscriptionId, final Subscription body, final ZonedDateTime requestedDate, final Boolean callCompletion, final Long callTimeoutSec, final BillingActionPolicy billingPolicy, final Map pluginProperty, final RequestOptions inputOptions) throws KillBillClientException {
Preconditions.checkNotNull(subscriptionId, "Missing the required parameter 'subscriptionId' when calling changeSubscriptionPlan");
Preconditions.checkNotNull(body, "Missing the required parameter 'body' when calling changeSubscriptionPlan");
@@ -257,7 +259,7 @@ public void changeSubscriptionPlan(final UUID subscriptionId, final Subscription
final Multimap queryParams = new TreeMapSetMultimap<>(inputOptions.getQueryParams());
if (requestedDate != null) {
- queryParams.put("requestedDate", String.valueOf(requestedDate));
+ queryParams.put("requestedDate", DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(requestedDate));
}
if (callCompletion != null) {
queryParams.put("callCompletion", String.valueOf(callCompletion));
@@ -327,21 +329,21 @@ public Subscription createSubscription(final Subscription body, final LocalDate
return httpClient.doPost(uri, body, Subscription.class, requestOptions);
}
- public Subscription createSubscription(final Subscription body, final DateTime entitlementDate, final DateTime billingDate, final Map pluginProperty, final RequestOptions inputOptions) throws KillBillClientException {
+ public Subscription createSubscription(final Subscription body, final ZonedDateTime entitlementDate, final ZonedDateTime billingDate, final Map pluginProperty, final RequestOptions inputOptions) throws KillBillClientException {
return createSubscription(body, entitlementDate, billingDate, Boolean.valueOf(true), Boolean.valueOf(false), Boolean.valueOf(false), Boolean.valueOf(false), Long.valueOf(3), pluginProperty, inputOptions);
}
- public Subscription createSubscription(final Subscription body, final DateTime entitlementDate, final DateTime billingDate, final Boolean renameKeyIfExistsAndUnused, final Boolean migrated, final Boolean skipResponse, final Boolean callCompletion, final Long callTimeoutSec, final Map pluginProperty, final RequestOptions inputOptions) throws KillBillClientException {
+ public Subscription createSubscription(final Subscription body, final ZonedDateTime entitlementDate, final ZonedDateTime billingDate, final Boolean renameKeyIfExistsAndUnused, final Boolean migrated, final Boolean skipResponse, final Boolean callCompletion, final Long callTimeoutSec, final Map pluginProperty, final RequestOptions inputOptions) throws KillBillClientException {
Preconditions.checkNotNull(body, "Missing the required parameter 'body' when calling createSubscription");
final String uri = "/1.0/kb/subscriptions";
final Multimap queryParams = new TreeMapSetMultimap<>(inputOptions.getQueryParams());
if (entitlementDate != null) {
- queryParams.put("entitlementDate", String.valueOf(entitlementDate));
+ queryParams.put("entitlementDate", DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(entitlementDate));
}
if (billingDate != null) {
- queryParams.put("billingDate", String.valueOf(billingDate));
+ queryParams.put("billingDate", DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(billingDate));
}
if (renameKeyIfExistsAndUnused != null) {
queryParams.put("renameKeyIfExistsAndUnused", String.valueOf(renameKeyIfExistsAndUnused));
@@ -455,21 +457,21 @@ public Bundle createSubscriptionWithAddOns(final Subscriptions body, final Local
return httpClient.doPost(uri, body, Bundle.class, requestOptions);
}
- public Bundle createSubscriptionWithAddOns(final Subscriptions body, final DateTime entitlementDate, final DateTime billingDate, final Map pluginProperty, final RequestOptions inputOptions) throws KillBillClientException {
+ public Bundle createSubscriptionWithAddOns(final Subscriptions body, final ZonedDateTime entitlementDate, final ZonedDateTime billingDate, final Map pluginProperty, final RequestOptions inputOptions) throws KillBillClientException {
return createSubscriptionWithAddOns(body, entitlementDate, billingDate, Boolean.valueOf(false), Boolean.valueOf(false), Boolean.valueOf(true), Boolean.valueOf(false), Long.valueOf(3), pluginProperty, inputOptions);
}
- public Bundle createSubscriptionWithAddOns(final Subscriptions body, final DateTime entitlementDate, final DateTime billingDate, final Boolean migrated, final Boolean skipResponse, final Boolean renameKeyIfExistsAndUnused, final Boolean callCompletion, final Long callTimeoutSec, final Map pluginProperty, final RequestOptions inputOptions) throws KillBillClientException {
+ public Bundle createSubscriptionWithAddOns(final Subscriptions body, final ZonedDateTime entitlementDate, final ZonedDateTime billingDate, final Boolean migrated, final Boolean skipResponse, final Boolean renameKeyIfExistsAndUnused, final Boolean callCompletion, final Long callTimeoutSec, final Map pluginProperty, final RequestOptions inputOptions) throws KillBillClientException {
Preconditions.checkNotNull(body, "Missing the required parameter 'body' when calling createSubscriptionWithAddOns");
final String uri = "/1.0/kb/subscriptions/createSubscriptionWithAddOns";
final Multimap queryParams = new TreeMapSetMultimap<>(inputOptions.getQueryParams());
if (entitlementDate != null) {
- queryParams.put("entitlementDate", String.valueOf(entitlementDate));
+ queryParams.put("entitlementDate", DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(entitlementDate));
}
if (billingDate != null) {
- queryParams.put("billingDate", String.valueOf(billingDate));
+ queryParams.put("billingDate", DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(billingDate));
}
if (migrated != null) {
queryParams.put("migrated", String.valueOf(migrated));
diff --git a/src/main/java/org/killbill/billing/client/api/gen/TagApi.java b/src/main/java/org/killbill/billing/client/api/gen/TagApi.java
index c08258f..dbaa941 100644
--- a/src/main/java/org/killbill/billing/client/api/gen/TagApi.java
+++ b/src/main/java/org/killbill/billing/client/api/gen/TagApi.java
@@ -30,6 +30,8 @@
import org.killbill.billing.client.model.Tags;
import org.killbill.billing.util.api.AuditLevel;
+import java.time.format.DateTimeFormatter;
+
import org.killbill.billing.client.Converter;
import org.killbill.billing.client.KillBillClientException;
import org.killbill.billing.client.KillBillHttpClient;
diff --git a/src/main/java/org/killbill/billing/client/api/gen/TagDefinitionApi.java b/src/main/java/org/killbill/billing/client/api/gen/TagDefinitionApi.java
index 2c7a8f6..12ce629 100644
--- a/src/main/java/org/killbill/billing/client/api/gen/TagDefinitionApi.java
+++ b/src/main/java/org/killbill/billing/client/api/gen/TagDefinitionApi.java
@@ -30,6 +30,8 @@
import java.util.List;
import org.killbill.billing.client.model.TagDefinitions;
+import java.time.format.DateTimeFormatter;
+
import org.killbill.billing.client.Converter;
import org.killbill.billing.client.KillBillClientException;
import org.killbill.billing.client.KillBillHttpClient;
diff --git a/src/main/java/org/killbill/billing/client/api/gen/TenantApi.java b/src/main/java/org/killbill/billing/client/api/gen/TenantApi.java
index 1283616..af01c31 100644
--- a/src/main/java/org/killbill/billing/client/api/gen/TenantApi.java
+++ b/src/main/java/org/killbill/billing/client/api/gen/TenantApi.java
@@ -28,6 +28,8 @@
import org.killbill.billing.client.model.TenantKeyValues;
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;
diff --git a/src/main/java/org/killbill/billing/client/api/gen/UsageApi.java b/src/main/java/org/killbill/billing/client/api/gen/UsageApi.java
index a1980e4..396cf6f 100644
--- a/src/main/java/org/killbill/billing/client/api/gen/UsageApi.java
+++ b/src/main/java/org/killbill/billing/client/api/gen/UsageApi.java
@@ -22,12 +22,14 @@
import java.util.Objects;
-import org.joda.time.LocalDate;
+import java.time.LocalDate;
import org.killbill.billing.client.model.gen.RolledUpUsage;
import org.killbill.billing.client.model.gen.SubscriptionUsageRecord;
import java.util.UUID;
import java.util.Map;
+import java.time.format.DateTimeFormatter;
+
import org.killbill.billing.client.Converter;
import org.killbill.billing.client.KillBillClientException;
import org.killbill.billing.client.KillBillHttpClient;
diff --git a/src/main/java/org/killbill/billing/client/model/CatalogVersions.java b/src/main/java/org/killbill/billing/client/model/CatalogVersions.java
index c5977d6..21055ea 100644
--- a/src/main/java/org/killbill/billing/client/model/CatalogVersions.java
+++ b/src/main/java/org/killbill/billing/client/model/CatalogVersions.java
@@ -21,7 +21,7 @@
import java.util.ArrayList;
-import org.joda.time.DateTime;
+import java.time.ZonedDateTime;
-public class CatalogVersions extends ArrayList {
+public class CatalogVersions extends ArrayList {
}
diff --git a/src/main/java/org/killbill/billing/client/model/DateTimes.java b/src/main/java/org/killbill/billing/client/model/DateTimes.java
index d040dd3..39c3e08 100644
--- a/src/main/java/org/killbill/billing/client/model/DateTimes.java
+++ b/src/main/java/org/killbill/billing/client/model/DateTimes.java
@@ -21,7 +21,7 @@
import java.util.ArrayList;
-import org.joda.time.DateTime;
+import java.time.ZonedDateTime;
-public class DateTimes extends ArrayList {
+public class DateTimes extends ArrayList {
}
diff --git a/src/main/java/org/killbill/billing/client/model/gen/Account.java b/src/main/java/org/killbill/billing/client/model/gen/Account.java
index 965630a..ccc6d67 100644
--- a/src/main/java/org/killbill/billing/client/model/gen/Account.java
+++ b/src/main/java/org/killbill/billing/client/model/gen/Account.java
@@ -24,10 +24,10 @@
import java.util.Arrays;
import com.fasterxml.jackson.annotation.JsonProperty;
import java.math.BigDecimal;
+import java.time.ZonedDateTime;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
-import org.joda.time.DateTime;
import org.killbill.billing.catalog.api.Currency;
import org.killbill.billing.client.model.gen.AuditLog;
@@ -61,7 +61,7 @@ public class Account extends KillBillObject {
private UUID paymentMethodId = null;
- private DateTime referenceTime = null;
+ private ZonedDateTime referenceTime = null;
private String timeZone = null;
@@ -106,7 +106,7 @@ public Account(final UUID accountId,
final UUID parentAccountId,
final Boolean isPaymentDelegatedToParent,
final UUID paymentMethodId,
- final DateTime referenceTime,
+ final ZonedDateTime referenceTime,
final String timeZone,
final String address1,
final String address2,
@@ -243,12 +243,12 @@ public UUID getPaymentMethodId() {
return paymentMethodId;
}
- public Account setReferenceTime(final DateTime referenceTime) {
+ public Account setReferenceTime(final ZonedDateTime referenceTime) {
this.referenceTime = referenceTime;
return this;
}
- public DateTime getReferenceTime() {
+ public ZonedDateTime getReferenceTime() {
return referenceTime;
}
diff --git a/src/main/java/org/killbill/billing/client/model/gen/AuditLog.java b/src/main/java/org/killbill/billing/client/model/gen/AuditLog.java
index 299e406..5bf3dde 100644
--- a/src/main/java/org/killbill/billing/client/model/gen/AuditLog.java
+++ b/src/main/java/org/killbill/billing/client/model/gen/AuditLog.java
@@ -22,8 +22,8 @@
import java.util.Objects;
import java.util.Arrays;
+import java.time.ZonedDateTime;
import java.util.UUID;
-import org.joda.time.DateTime;
import org.killbill.billing.ObjectType;
/**
@@ -38,7 +38,7 @@ public class AuditLog {
private String changeType = null;
- private DateTime changeDate = null;
+ private ZonedDateTime changeDate = null;
private ObjectType objectType = null;
@@ -59,7 +59,7 @@ public AuditLog() {
}
public AuditLog(final String changeType,
- final DateTime changeDate,
+ final ZonedDateTime changeDate,
final ObjectType objectType,
final UUID objectId,
final String changedBy,
@@ -89,12 +89,12 @@ public String getChangeType() {
return changeType;
}
- public AuditLog setChangeDate(final DateTime changeDate) {
+ public AuditLog setChangeDate(final ZonedDateTime changeDate) {
this.changeDate = changeDate;
return this;
}
- public DateTime getChangeDate() {
+ public ZonedDateTime getChangeDate() {
return changeDate;
}
diff --git a/src/main/java/org/killbill/billing/client/model/gen/BlockingState.java b/src/main/java/org/killbill/billing/client/model/gen/BlockingState.java
index 2e81c56..802a1b1 100644
--- a/src/main/java/org/killbill/billing/client/model/gen/BlockingState.java
+++ b/src/main/java/org/killbill/billing/client/model/gen/BlockingState.java
@@ -23,10 +23,10 @@
import java.util.Objects;
import java.util.Arrays;
import com.fasterxml.jackson.annotation.JsonProperty;
+import java.time.ZonedDateTime;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
-import org.joda.time.DateTime;
import org.killbill.billing.client.model.gen.AuditLog;
import org.killbill.billing.entitlement.api.BlockingStateType;
@@ -52,7 +52,7 @@ public class BlockingState extends KillBillObject {
private Boolean isBlockBilling = null;
- private DateTime effectiveDate = null;
+ private ZonedDateTime effectiveDate = null;
private BlockingStateType type = null;
@@ -67,7 +67,7 @@ public BlockingState(final UUID blockedId,
final Boolean isBlockChange,
final Boolean isBlockEntitlement,
final Boolean isBlockBilling,
- final DateTime effectiveDate,
+ final ZonedDateTime effectiveDate,
final BlockingStateType type,
final List auditLogs) {
super(auditLogs);
@@ -140,12 +140,12 @@ public Boolean isBlockBilling() {
return isBlockBilling;
}
- public BlockingState setEffectiveDate(final DateTime effectiveDate) {
+ public BlockingState setEffectiveDate(final ZonedDateTime effectiveDate) {
this.effectiveDate = effectiveDate;
return this;
}
- public DateTime getEffectiveDate() {
+ public ZonedDateTime getEffectiveDate() {
return effectiveDate;
}
diff --git a/src/main/java/org/killbill/billing/client/model/gen/Catalog.java b/src/main/java/org/killbill/billing/client/model/gen/Catalog.java
index 9eccd54..dc05a82 100644
--- a/src/main/java/org/killbill/billing/client/model/gen/Catalog.java
+++ b/src/main/java/org/killbill/billing/client/model/gen/Catalog.java
@@ -22,9 +22,9 @@
import java.util.Objects;
import java.util.Arrays;
+import java.time.ZonedDateTime;
import java.util.ArrayList;
import java.util.List;
-import org.joda.time.DateTime;
import org.killbill.billing.catalog.api.Currency;
import org.killbill.billing.client.model.gen.PriceList;
import org.killbill.billing.client.model.gen.Product;
@@ -42,7 +42,7 @@ public class Catalog {
private String name = null;
- private DateTime effectiveDate = null;
+ private ZonedDateTime effectiveDate = null;
private List currencies = null;
@@ -57,7 +57,7 @@ public Catalog() {
}
public Catalog(final String name,
- final DateTime effectiveDate,
+ final ZonedDateTime effectiveDate,
final List currencies,
final List units,
final List products,
@@ -81,12 +81,12 @@ public String getName() {
return name;
}
- public Catalog setEffectiveDate(final DateTime effectiveDate) {
+ public Catalog setEffectiveDate(final ZonedDateTime effectiveDate) {
this.effectiveDate = effectiveDate;
return this;
}
- public DateTime getEffectiveDate() {
+ public ZonedDateTime getEffectiveDate() {
return effectiveDate;
}
diff --git a/src/main/java/org/killbill/billing/client/model/gen/EventSubscription.java b/src/main/java/org/killbill/billing/client/model/gen/EventSubscription.java
index 7b67e66..737fd8c 100644
--- a/src/main/java/org/killbill/billing/client/model/gen/EventSubscription.java
+++ b/src/main/java/org/killbill/billing/client/model/gen/EventSubscription.java
@@ -23,10 +23,10 @@
import java.util.Objects;
import java.util.Arrays;
import com.fasterxml.jackson.annotation.JsonProperty;
+import java.time.ZonedDateTime;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
-import org.joda.time.DateTime;
import org.killbill.billing.catalog.api.BillingPeriod;
import org.killbill.billing.client.model.gen.AuditLog;
import org.killbill.billing.entitlement.api.SubscriptionEventType;
@@ -45,9 +45,9 @@ public class EventSubscription extends KillBillObject {
private BillingPeriod billingPeriod = null;
- private DateTime effectiveDate = null;
+ private ZonedDateTime effectiveDate = null;
- private DateTime catalogEffectiveDate = null;
+ private ZonedDateTime catalogEffectiveDate = null;
private String plan = null;
@@ -74,8 +74,8 @@ public EventSubscription() {
public EventSubscription(final UUID eventId,
final BillingPeriod billingPeriod,
- final DateTime effectiveDate,
- final DateTime catalogEffectiveDate,
+ final ZonedDateTime effectiveDate,
+ final ZonedDateTime catalogEffectiveDate,
final String plan,
final String product,
final String priceList,
@@ -122,21 +122,21 @@ public BillingPeriod getBillingPeriod() {
return billingPeriod;
}
- public EventSubscription setEffectiveDate(final DateTime effectiveDate) {
+ public EventSubscription setEffectiveDate(final ZonedDateTime effectiveDate) {
this.effectiveDate = effectiveDate;
return this;
}
- public DateTime getEffectiveDate() {
+ public ZonedDateTime getEffectiveDate() {
return effectiveDate;
}
- public EventSubscription setCatalogEffectiveDate(final DateTime catalogEffectiveDate) {
+ public EventSubscription setCatalogEffectiveDate(final ZonedDateTime catalogEffectiveDate) {
this.catalogEffectiveDate = catalogEffectiveDate;
return this;
}
- public DateTime getCatalogEffectiveDate() {
+ public ZonedDateTime getCatalogEffectiveDate() {
return catalogEffectiveDate;
}
diff --git a/src/main/java/org/killbill/billing/client/model/gen/Invoice.java b/src/main/java/org/killbill/billing/client/model/gen/Invoice.java
index cf51a14..c5127f1 100644
--- a/src/main/java/org/killbill/billing/client/model/gen/Invoice.java
+++ b/src/main/java/org/killbill/billing/client/model/gen/Invoice.java
@@ -24,10 +24,10 @@
import java.util.Arrays;
import com.fasterxml.jackson.annotation.JsonProperty;
import java.math.BigDecimal;
+import java.time.LocalDate;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
-import org.joda.time.LocalDate;
import org.killbill.billing.catalog.api.Currency;
import org.killbill.billing.client.model.gen.AuditLog;
import org.killbill.billing.client.model.gen.InvoiceItem;
diff --git a/src/main/java/org/killbill/billing/client/model/gen/InvoiceDryRun.java b/src/main/java/org/killbill/billing/client/model/gen/InvoiceDryRun.java
index a3d0d8c..71899f8 100644
--- a/src/main/java/org/killbill/billing/client/model/gen/InvoiceDryRun.java
+++ b/src/main/java/org/killbill/billing/client/model/gen/InvoiceDryRun.java
@@ -22,10 +22,10 @@
import java.util.Objects;
import java.util.Arrays;
+import java.time.LocalDate;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
-import org.joda.time.LocalDate;
import org.killbill.billing.catalog.api.BillingActionPolicy;
import org.killbill.billing.catalog.api.BillingPeriod;
import org.killbill.billing.catalog.api.PhaseType;
diff --git a/src/main/java/org/killbill/billing/client/model/gen/InvoiceItem.java b/src/main/java/org/killbill/billing/client/model/gen/InvoiceItem.java
index 58acd03..714ee02 100644
--- a/src/main/java/org/killbill/billing/client/model/gen/InvoiceItem.java
+++ b/src/main/java/org/killbill/billing/client/model/gen/InvoiceItem.java
@@ -23,11 +23,11 @@
import java.util.Objects;
import java.util.Arrays;
import java.math.BigDecimal;
+import java.time.LocalDate;
+import java.time.ZonedDateTime;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
-import org.joda.time.DateTime;
-import org.joda.time.LocalDate;
import org.killbill.billing.catalog.api.Currency;
import org.killbill.billing.client.model.gen.AuditLog;
import org.killbill.billing.client.model.gen.InvoiceItem;
@@ -91,7 +91,7 @@ public class InvoiceItem extends KillBillObject {
private String itemDetails = null;
- private DateTime catalogEffectiveDate = null;
+ private ZonedDateTime catalogEffectiveDate = null;
private List childItems = null;
@@ -124,7 +124,7 @@ public InvoiceItem(final UUID invoiceItemId,
final Currency currency,
final BigDecimal quantity,
final String itemDetails,
- final DateTime catalogEffectiveDate,
+ final ZonedDateTime catalogEffectiveDate,
final List childItems,
final List auditLogs) {
super(auditLogs);
@@ -374,12 +374,12 @@ public String getItemDetails() {
return itemDetails;
}
- public InvoiceItem setCatalogEffectiveDate(final DateTime catalogEffectiveDate) {
+ public InvoiceItem setCatalogEffectiveDate(final ZonedDateTime catalogEffectiveDate) {
this.catalogEffectiveDate = catalogEffectiveDate;
return this;
}
- public DateTime getCatalogEffectiveDate() {
+ public ZonedDateTime getCatalogEffectiveDate() {
return catalogEffectiveDate;
}
diff --git a/src/main/java/org/killbill/billing/client/model/gen/InvoicePaymentTransaction.java b/src/main/java/org/killbill/billing/client/model/gen/InvoicePaymentTransaction.java
index 1290ad1..0916428 100644
--- a/src/main/java/org/killbill/billing/client/model/gen/InvoicePaymentTransaction.java
+++ b/src/main/java/org/killbill/billing/client/model/gen/InvoicePaymentTransaction.java
@@ -24,10 +24,10 @@
import java.util.Arrays;
import com.fasterxml.jackson.annotation.JsonProperty;
import java.math.BigDecimal;
+import java.time.ZonedDateTime;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
-import org.joda.time.DateTime;
import org.killbill.billing.catalog.api.Currency;
import org.killbill.billing.client.model.gen.AuditLog;
import org.killbill.billing.client.model.gen.InvoiceItem;
@@ -59,7 +59,7 @@ public class InvoicePaymentTransaction extends KillBillObject {
private Currency currency = null;
- private DateTime effectiveDate = null;
+ private ZonedDateTime effectiveDate = null;
private BigDecimal processedAmount = null;
@@ -93,7 +93,7 @@ public InvoicePaymentTransaction(final UUID transactionId,
final TransactionType transactionType,
final BigDecimal amount,
final Currency currency,
- final DateTime effectiveDate,
+ final ZonedDateTime effectiveDate,
final BigDecimal processedAmount,
final Currency processedCurrency,
final TransactionStatus status,
@@ -191,12 +191,12 @@ public Currency getCurrency() {
return currency;
}
- public InvoicePaymentTransaction setEffectiveDate(final DateTime effectiveDate) {
+ public InvoicePaymentTransaction setEffectiveDate(final ZonedDateTime effectiveDate) {
this.effectiveDate = effectiveDate;
return this;
}
- public DateTime getEffectiveDate() {
+ public ZonedDateTime getEffectiveDate() {
return effectiveDate;
}
diff --git a/src/main/java/org/killbill/billing/client/model/gen/NodeInfo.java b/src/main/java/org/killbill/billing/client/model/gen/NodeInfo.java
index 8b4fb77..57c65c5 100644
--- a/src/main/java/org/killbill/billing/client/model/gen/NodeInfo.java
+++ b/src/main/java/org/killbill/billing/client/model/gen/NodeInfo.java
@@ -22,9 +22,9 @@
import java.util.Objects;
import java.util.Arrays;
+import java.time.ZonedDateTime;
import java.util.ArrayList;
import java.util.List;
-import org.joda.time.DateTime;
import org.killbill.billing.client.model.gen.PluginInfo;
/**
@@ -39,9 +39,9 @@ public class NodeInfo {
private String nodeName = null;
- private DateTime bootTime = null;
+ private ZonedDateTime bootTime = null;
- private DateTime lastUpdatedDate = null;
+ private ZonedDateTime lastUpdatedDate = null;
private String kbVersion = null;
@@ -60,8 +60,8 @@ public NodeInfo() {
}
public NodeInfo(final String nodeName,
- final DateTime bootTime,
- final DateTime lastUpdatedDate,
+ final ZonedDateTime bootTime,
+ final ZonedDateTime lastUpdatedDate,
final String kbVersion,
final String apiVersion,
final String pluginApiVersion,
@@ -90,21 +90,21 @@ public String getNodeName() {
return nodeName;
}
- public NodeInfo setBootTime(final DateTime bootTime) {
+ public NodeInfo setBootTime(final ZonedDateTime bootTime) {
this.bootTime = bootTime;
return this;
}
- public DateTime getBootTime() {
+ public ZonedDateTime getBootTime() {
return bootTime;
}
- public NodeInfo setLastUpdatedDate(final DateTime lastUpdatedDate) {
+ public NodeInfo setLastUpdatedDate(final ZonedDateTime lastUpdatedDate) {
this.lastUpdatedDate = lastUpdatedDate;
return this;
}
- public DateTime getLastUpdatedDate() {
+ public ZonedDateTime getLastUpdatedDate() {
return lastUpdatedDate;
}
diff --git a/src/main/java/org/killbill/billing/client/model/gen/PaymentAttempt.java b/src/main/java/org/killbill/billing/client/model/gen/PaymentAttempt.java
index 378698b..4c15f10 100644
--- a/src/main/java/org/killbill/billing/client/model/gen/PaymentAttempt.java
+++ b/src/main/java/org/killbill/billing/client/model/gen/PaymentAttempt.java
@@ -23,10 +23,10 @@
import java.util.Objects;
import java.util.Arrays;
import java.math.BigDecimal;
+import java.time.ZonedDateTime;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
-import org.joda.time.DateTime;
import org.killbill.billing.catalog.api.Currency;
import org.killbill.billing.client.model.gen.AuditLog;
import org.killbill.billing.client.model.gen.PluginProperty;
@@ -54,7 +54,7 @@ public class PaymentAttempt extends KillBillObject {
private TransactionType transactionType = null;
- private DateTime effectiveDate = null;
+ private ZonedDateTime effectiveDate = null;
private String stateName = null;
@@ -77,7 +77,7 @@ public PaymentAttempt(final UUID accountId,
final UUID transactionId,
final String transactionExternalKey,
final TransactionType transactionType,
- final DateTime effectiveDate,
+ final ZonedDateTime effectiveDate,
final String stateName,
final BigDecimal amount,
final Currency currency,
@@ -155,12 +155,12 @@ public TransactionType getTransactionType() {
return transactionType;
}
- public PaymentAttempt setEffectiveDate(final DateTime effectiveDate) {
+ public PaymentAttempt setEffectiveDate(final ZonedDateTime effectiveDate) {
this.effectiveDate = effectiveDate;
return this;
}
- public DateTime getEffectiveDate() {
+ public ZonedDateTime getEffectiveDate() {
return effectiveDate;
}
diff --git a/src/main/java/org/killbill/billing/client/model/gen/PaymentTransaction.java b/src/main/java/org/killbill/billing/client/model/gen/PaymentTransaction.java
index 3968dfb..e6a6ed9 100644
--- a/src/main/java/org/killbill/billing/client/model/gen/PaymentTransaction.java
+++ b/src/main/java/org/killbill/billing/client/model/gen/PaymentTransaction.java
@@ -23,10 +23,10 @@
import java.util.Objects;
import java.util.Arrays;
import java.math.BigDecimal;
+import java.time.ZonedDateTime;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
-import org.joda.time.DateTime;
import org.killbill.billing.catalog.api.Currency;
import org.killbill.billing.client.model.gen.AuditLog;
import org.killbill.billing.client.model.gen.PluginProperty;
@@ -57,7 +57,7 @@ public class PaymentTransaction extends KillBillObject {
private Currency currency = null;
- private DateTime effectiveDate = null;
+ private ZonedDateTime effectiveDate = null;
private BigDecimal processedAmount = null;
@@ -87,7 +87,7 @@ public PaymentTransaction(final UUID transactionId,
final TransactionType transactionType,
final BigDecimal amount,
final Currency currency,
- final DateTime effectiveDate,
+ final ZonedDateTime effectiveDate,
final BigDecimal processedAmount,
final Currency processedCurrency,
final TransactionStatus status,
@@ -181,12 +181,12 @@ public Currency getCurrency() {
return currency;
}
- public PaymentTransaction setEffectiveDate(final DateTime effectiveDate) {
+ public PaymentTransaction setEffectiveDate(final ZonedDateTime effectiveDate) {
this.effectiveDate = effectiveDate;
return this;
}
- public DateTime getEffectiveDate() {
+ public ZonedDateTime getEffectiveDate() {
return effectiveDate;
}
diff --git a/src/main/java/org/killbill/billing/client/model/gen/RolledUpUsage.java b/src/main/java/org/killbill/billing/client/model/gen/RolledUpUsage.java
index c153470..bf06ef2 100644
--- a/src/main/java/org/killbill/billing/client/model/gen/RolledUpUsage.java
+++ b/src/main/java/org/killbill/billing/client/model/gen/RolledUpUsage.java
@@ -22,10 +22,10 @@
import java.util.Objects;
import java.util.Arrays;
+import java.time.ZonedDateTime;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
-import org.joda.time.DateTime;
import org.killbill.billing.client.model.gen.RolledUpUnit;
/**
@@ -40,9 +40,9 @@ public class RolledUpUsage {
private UUID subscriptionId = null;
- private DateTime startDate = null;
+ private ZonedDateTime startDate = null;
- private DateTime endDate = null;
+ private ZonedDateTime endDate = null;
private List rolledUpUnits = null;
@@ -51,8 +51,8 @@ public RolledUpUsage() {
}
public RolledUpUsage(final UUID subscriptionId,
- final DateTime startDate,
- final DateTime endDate,
+ final ZonedDateTime startDate,
+ final ZonedDateTime endDate,
final List rolledUpUnits) {
this.subscriptionId = subscriptionId;
this.startDate = startDate;
@@ -71,21 +71,21 @@ public UUID getSubscriptionId() {
return subscriptionId;
}
- public RolledUpUsage setStartDate(final DateTime startDate) {
+ public RolledUpUsage setStartDate(final ZonedDateTime startDate) {
this.startDate = startDate;
return this;
}
- public DateTime getStartDate() {
+ public ZonedDateTime getStartDate() {
return startDate;
}
- public RolledUpUsage setEndDate(final DateTime endDate) {
+ public RolledUpUsage setEndDate(final ZonedDateTime endDate) {
this.endDate = endDate;
return this;
}
- public DateTime getEndDate() {
+ public ZonedDateTime getEndDate() {
return endDate;
}
diff --git a/src/main/java/org/killbill/billing/client/model/gen/Session.java b/src/main/java/org/killbill/billing/client/model/gen/Session.java
index ecc7a63..a5a87c4 100644
--- a/src/main/java/org/killbill/billing/client/model/gen/Session.java
+++ b/src/main/java/org/killbill/billing/client/model/gen/Session.java
@@ -22,7 +22,7 @@
import java.util.Objects;
import java.util.Arrays;
-import org.joda.time.DateTime;
+import java.time.ZonedDateTime;
/**
* DO NOT EDIT !!!
@@ -36,9 +36,9 @@ public class Session {
private String id = null;
- private DateTime startDate = null;
+ private ZonedDateTime startDate = null;
- private DateTime lastAccessDate = null;
+ private ZonedDateTime lastAccessDate = null;
private Long timeout = null;
@@ -49,8 +49,8 @@ public Session() {
}
public Session(final String id,
- final DateTime startDate,
- final DateTime lastAccessDate,
+ final ZonedDateTime startDate,
+ final ZonedDateTime lastAccessDate,
final Long timeout,
final String host) {
this.id = id;
@@ -71,21 +71,21 @@ public String getId() {
return id;
}
- public Session setStartDate(final DateTime startDate) {
+ public Session setStartDate(final ZonedDateTime startDate) {
this.startDate = startDate;
return this;
}
- public DateTime getStartDate() {
+ public ZonedDateTime getStartDate() {
return startDate;
}
- public Session setLastAccessDate(final DateTime lastAccessDate) {
+ public Session setLastAccessDate(final ZonedDateTime lastAccessDate) {
this.lastAccessDate = lastAccessDate;
return this;
}
- public DateTime getLastAccessDate() {
+ public ZonedDateTime getLastAccessDate() {
return lastAccessDate;
}
diff --git a/src/main/java/org/killbill/billing/client/model/gen/Subscription.java b/src/main/java/org/killbill/billing/client/model/gen/Subscription.java
index 9074f34..e7b3144 100644
--- a/src/main/java/org/killbill/billing/client/model/gen/Subscription.java
+++ b/src/main/java/org/killbill/billing/client/model/gen/Subscription.java
@@ -22,11 +22,11 @@
import java.util.Objects;
import java.util.Arrays;
+import java.time.LocalDate;
+import java.time.ZonedDateTime;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
-import org.joda.time.DateTime;
-import org.joda.time.LocalDate;
import org.killbill.billing.catalog.api.BillingPeriod;
import org.killbill.billing.catalog.api.PhaseType;
import org.killbill.billing.catalog.api.ProductCategory;
@@ -56,7 +56,7 @@ public class Subscription extends KillBillObject {
private String externalKey = null;
- private DateTime startDate = null;
+ private ZonedDateTime startDate = null;
private String productName = null;
@@ -74,13 +74,13 @@ public class Subscription extends KillBillObject {
private EntitlementSourceType sourceType = null;
- private DateTime cancelledDate = null;
+ private ZonedDateTime cancelledDate = null;
private LocalDate chargedThroughDate = null;
- private DateTime billingStartDate = null;
+ private ZonedDateTime billingStartDate = null;
- private DateTime billingEndDate = null;
+ private ZonedDateTime billingEndDate = null;
private Integer billCycleDayLocal = null;
@@ -102,7 +102,7 @@ public Subscription(final UUID accountId,
final String bundleExternalKey,
final UUID subscriptionId,
final String externalKey,
- final DateTime startDate,
+ final ZonedDateTime startDate,
final String productName,
final ProductCategory productCategory,
final BillingPeriod billingPeriod,
@@ -111,10 +111,10 @@ public Subscription(final UUID accountId,
final String planName,
final EntitlementState state,
final EntitlementSourceType sourceType,
- final DateTime cancelledDate,
+ final ZonedDateTime cancelledDate,
final LocalDate chargedThroughDate,
- final DateTime billingStartDate,
- final DateTime billingEndDate,
+ final ZonedDateTime billingStartDate,
+ final ZonedDateTime billingEndDate,
final Integer billCycleDayLocal,
final Integer quantity,
final List events,
@@ -194,12 +194,12 @@ public String getExternalKey() {
return externalKey;
}
- public Subscription setStartDate(final DateTime startDate) {
+ public Subscription setStartDate(final ZonedDateTime startDate) {
this.startDate = startDate;
return this;
}
- public DateTime getStartDate() {
+ public ZonedDateTime getStartDate() {
return startDate;
}
@@ -275,12 +275,12 @@ public EntitlementSourceType getSourceType() {
return sourceType;
}
- public Subscription setCancelledDate(final DateTime cancelledDate) {
+ public Subscription setCancelledDate(final ZonedDateTime cancelledDate) {
this.cancelledDate = cancelledDate;
return this;
}
- public DateTime getCancelledDate() {
+ public ZonedDateTime getCancelledDate() {
return cancelledDate;
}
@@ -293,21 +293,21 @@ public LocalDate getChargedThroughDate() {
return chargedThroughDate;
}
- public Subscription setBillingStartDate(final DateTime billingStartDate) {
+ public Subscription setBillingStartDate(final ZonedDateTime billingStartDate) {
this.billingStartDate = billingStartDate;
return this;
}
- public DateTime getBillingStartDate() {
+ public ZonedDateTime getBillingStartDate() {
return billingStartDate;
}
- public Subscription setBillingEndDate(final DateTime billingEndDate) {
+ public Subscription setBillingEndDate(final ZonedDateTime billingEndDate) {
this.billingEndDate = billingEndDate;
return this;
}
- public DateTime getBillingEndDate() {
+ public ZonedDateTime getBillingEndDate() {
return billingEndDate;
}
diff --git a/src/main/java/org/killbill/billing/client/model/gen/UsageRecord.java b/src/main/java/org/killbill/billing/client/model/gen/UsageRecord.java
index b79b1b6..39ee4ef 100644
--- a/src/main/java/org/killbill/billing/client/model/gen/UsageRecord.java
+++ b/src/main/java/org/killbill/billing/client/model/gen/UsageRecord.java
@@ -23,7 +23,7 @@
import java.util.Objects;
import java.util.Arrays;
import java.math.BigDecimal;
-import org.joda.time.DateTime;
+import java.time.ZonedDateTime;
/**
* DO NOT EDIT !!!
@@ -35,7 +35,7 @@
public class UsageRecord {
- private DateTime recordDate = null;
+ private ZonedDateTime recordDate = null;
private BigDecimal amount = null;
@@ -43,7 +43,7 @@ public class UsageRecord {
public UsageRecord() {
}
- public UsageRecord(final DateTime recordDate,
+ public UsageRecord(final ZonedDateTime recordDate,
final BigDecimal amount) {
this.recordDate = recordDate;
this.amount = amount;
@@ -51,12 +51,12 @@ public UsageRecord(final DateTime recordDate,
}
- public UsageRecord setRecordDate(final DateTime recordDate) {
+ public UsageRecord setRecordDate(final ZonedDateTime recordDate) {
this.recordDate = recordDate;
return this;
}
- public DateTime getRecordDate() {
+ public ZonedDateTime getRecordDate() {
return recordDate;
}