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 fdae7f7..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,83 +34,59 @@ tags:
- name: "PaymentTransaction"
- name: "Usage"
paths:
- /1.0/kb/accounts/{childAccountId}/transferCredit:
- put:
+ /1.0/kb/accounts/{accountId}/tags:
+ get:
tags:
- "Account"
- summary: "Move a given child credit to the parent level"
+ summary: "Retrieve account tags"
description: ""
- operationId: "transferChildCreditToParent"
- consumes:
- - "application/json"
+ operationId: "getAccountTags"
produces:
- "application/json"
parameters:
- - name: "childAccountId"
+ - name: "accountId"
in: "path"
required: true
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
+ - 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"
- 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}/auditLogsWithHistory:
- get:
- tags:
- - "Account"
- summary: "Retrieve account audit logs with history by account id"
- description: ""
- operationId: "getAccountAuditLogsWithHistory"
- produces:
- - "application/json"
- parameters:
- - name: "accountId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
responses:
"200":
description: "successful operation"
schema:
type: "array"
items:
- $ref: "#/definitions/AuditLog"
+ $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}/emails/{accountEmailId}/auditLogsWithHistory:
- get:
+ post:
tags:
- "Account"
- summary: "Retrieve account email audit logs with history by id"
+ summary: "Add tags to account"
description: ""
- operationId: "getAccountEmailAuditLogsWithHistory"
+ operationId: "createAccountTags"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
@@ -120,61 +96,47 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "accountEmailId"
- in: "path"
+ - in: "body"
+ name: "body"
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/block/{blockingId}/auditLogsWithHistory:
- get:
- tags:
- - "Account"
- summary: "Retrieve blocking state audit logs with history by id"
- description: ""
- operationId: "getBlockingStateAuditLogsWithHistory"
- produces:
- - "application/json"
- parameters:
- - name: "blockingId"
- in: "path"
+ schema:
+ type: "array"
+ items:
+ type: "string"
+ format: "uuid"
+ - 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: "Tag created successfully"
schema:
type: "array"
items:
- $ref: "#/definitions/AuditLog"
- "404":
- description: "Blocking state not found"
+ $ref: "#/definitions/Tag"
+ "400":
+ description: "Invalid account id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/invoices/pagination:
- get:
+ delete:
tags:
- "Account"
- summary: "Retrieve paginated invoices for account"
+ summary: "Remove tags from account"
description: ""
- operationId: "getInvoicesForAccountPaginated"
+ operationId: "deleteAccountTags"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
@@ -184,49 +146,43 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "offset"
+ - name: "tagDef"
in: "query"
required: false
- type: "integer"
- default: 0
- format: "int64"
- - name: "limit"
- in: "query"
+ type: "array"
+ items:
+ type: "string"
+ format: "uuid"
+ collectionFormat: "multi"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
required: false
- type: "integer"
- default: 100
- format: "int64"
- - name: "audit"
- in: "query"
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
required: false
type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/Invoice"
+ "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/{accountId}/paymentMethods:
+ /1.0/kb/accounts/{accountId}/customFields:
get:
tags:
- "Account"
- summary: "Retrieve account payment methods"
+ summary: "Retrieve account custom fields"
description: ""
- operationId: "getPaymentMethodsForAccount"
+ operationId: "getAccountCustomFields"
produces:
- "application/json"
parameters:
@@ -236,23 +192,6 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "withPluginInfo"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "includedDeleted"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- name: "audit"
in: "query"
required: false
@@ -268,11 +207,9 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/PaymentMethod"
+ $ref: "#/definitions/CustomField"
"400":
description: "Invalid account id supplied"
- "404":
- description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -280,9 +217,9 @@ paths:
post:
tags:
- "Account"
- summary: "Add a payment method"
+ summary: "Add custom fields to account"
description: ""
- operationId: "createPaymentMethod"
+ operationId: "createAccountCustomFields"
consumes:
- "application/json"
produces:
@@ -298,31 +235,9 @@ paths:
name: "body"
required: true
schema:
- $ref: "#/definitions/PaymentMethod"
- - name: "isDefault"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "payAllUnpaidInvoices"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "controlPluginName"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
+ type: "array"
+ items:
+ $ref: "#/definitions/CustomField"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -337,58 +252,41 @@ paths:
type: "string"
responses:
"201":
- description: "Payment method created"
+ description: "Custom field created successfully"
schema:
- $ref: "#/definitions/PaymentMethod"
+ type: "array"
+ items:
+ $ref: "#/definitions/CustomField"
"400":
description: "Invalid account id supplied"
- "404":
- description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/payments:
- post:
+ put:
tags:
- "Account"
- summary: "Trigger a payment using the account external key (authorization, purchase\
- \ or credit)"
+ summary: "Modify custom fields to account"
description: ""
- operationId: "processPaymentByExternalKey"
+ operationId: "modifyAccountCustomFields"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
+ - name: "accountId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
- in: "body"
name: "body"
required: true
schema:
- $ref: "#/definitions/PaymentTransaction"
- - name: "externalKey"
- in: "query"
- required: true
- type: "string"
- - name: "paymentMethodId"
- in: "query"
- required: false
- type: "string"
- format: "uuid"
- - name: "controlPluginName"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
+ type: "array"
+ items:
+ $ref: "#/definitions/CustomField"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -402,35 +300,20 @@ paths:
required: false
type: "string"
responses:
- "201":
- description: "Payment transaction created successfully"
- schema:
- $ref: "#/definitions/Payment"
+ "204":
+ description: "Successful operation"
"400":
- description: "Invalid account external key supplied"
- "404":
- description: "Account not found"
- "402":
- description: "Transaction declined by gateway"
- "422":
- description: "Payment is aborted by a control plugin"
- "502":
- description: "Failed to submit payment transaction"
- "503":
- description: "Payment in unknown status, failed to receive gateway response"
- "504":
- description: "Payment operation timeout"
+ description: "Invalid account id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/cbaRebalancing:
- put:
+ delete:
tags:
- "Account"
- summary: "Rebalance account CBA"
+ summary: "Remove custom fields from account"
description: ""
- operationId: "rebalanceExistingCBAOnAccount"
+ operationId: "deleteAccountCustomFields"
consumes:
- "application/json"
produces:
@@ -442,6 +325,14 @@ 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
@@ -463,13 +354,13 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/tags:
+ /1.0/kb/accounts/{accountId}/block:
get:
tags:
- "Account"
- summary: "Retrieve account tags"
+ summary: "Retrieve blocking states for account"
description: ""
- operationId: "getAccountTags"
+ operationId: "getBlockingStates"
produces:
- "application/json"
parameters:
@@ -479,11 +370,24 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "includedDeleted"
+ - name: "blockingStateTypes"
in: "query"
required: false
- type: "boolean"
- default: false
+ type: "array"
+ items:
+ type: "string"
+ enum:
+ - "SUBSCRIPTION"
+ - "SUBSCRIPTION_BUNDLE"
+ - "ACCOUNT"
+ collectionFormat: "multi"
+ - name: "blockingStateSvcs"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
- name: "audit"
in: "query"
required: false
@@ -499,11 +403,9 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/Tag"
+ $ref: "#/definitions/BlockingState"
"400":
description: "Invalid account id supplied"
- "404":
- description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -511,13 +413,11 @@ paths:
post:
tags:
- "Account"
- summary: "Add tags to account"
+ summary: "Block an account"
description: ""
- operationId: "createAccountTags"
+ operationId: "addAccountBlockingState"
consumes:
- "application/json"
- produces:
- - "application/json"
parameters:
- name: "accountId"
in: "path"
@@ -529,10 +429,19 @@ paths:
name: "body"
required: true
schema:
- type: "array"
- items:
- type: "string"
- format: "uuid"
+ $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
@@ -547,25 +456,26 @@ paths:
type: "string"
responses:
"201":
- description: "Tag created successfully"
+ description: "Blocking state created successfully"
schema:
type: "array"
items:
- $ref: "#/definitions/Tag"
+ $ref: "#/definitions/BlockingState"
"400":
description: "Invalid account id supplied"
+ "404":
+ description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- delete:
+ /1.0/kb/accounts/{accountId}/auditLogs:
+ get:
tags:
- "Account"
- summary: "Remove tags from account"
+ summary: "Retrieve audit logs by account id"
description: ""
- operationId: "deleteAccountTags"
- consumes:
- - "application/json"
+ operationId: "getAccountAuditLogs"
produces:
- "application/json"
parameters:
@@ -575,52 +485,43 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "tagDef"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- format: "uuid"
- collectionFormat: "multi"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
responses:
- "204":
- description: "Successful operation"
- "400":
- description: "Invalid account id supplied or account does not have a default\
- \ payment method (AUTO_PAY_OFF tag only)"
+ "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}/customFields:
+ /1.0/kb/accounts:
get:
tags:
- "Account"
- summary: "Retrieve account custom fields"
+ summary: "Retrieve an account by external key"
description: ""
- operationId: "getAccountCustomFields"
+ operationId: "getAccountByKey"
produces:
- "application/json"
parameters:
- - name: "accountId"
- in: "path"
+ - name: "externalKey"
+ in: "query"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
+ - name: "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
@@ -634,11 +535,9 @@ paths:
"200":
description: "successful operation"
schema:
- type: "array"
- items:
- $ref: "#/definitions/CustomField"
- "400":
- description: "Invalid account id supplied"
+ $ref: "#/definitions/Account"
+ "404":
+ description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -646,27 +545,19 @@ paths:
post:
tags:
- "Account"
- summary: "Add custom fields to account"
+ summary: "Create account"
description: ""
- operationId: "createAccountCustomFields"
+ 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"
- in: "body"
name: "body"
required: true
schema:
- type: "array"
- items:
- $ref: "#/definitions/CustomField"
+ $ref: "#/definitions/Account"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -681,70 +572,79 @@ paths:
type: "string"
responses:
"201":
- description: "Custom field created successfully"
+ description: "Account created successfully"
schema:
- type: "array"
- items:
- $ref: "#/definitions/CustomField"
+ $ref: "#/definitions/Account"
"400":
- description: "Invalid account id supplied"
+ description: "Invalid account data supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- put:
+ /1.0/kb/accounts/search/{searchKey}:
+ get:
tags:
- "Account"
- summary: "Modify custom fields to account"
+ summary: "Search accounts"
description: ""
- operationId: "modifyAccountCustomFields"
- consumes:
- - "application/json"
+ operationId: "searchAccounts"
produces:
- "application/json"
parameters:
- - name: "accountId"
+ - name: "searchKey"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- type: "array"
- items:
- $ref: "#/definitions/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"
+ pattern: ".*"
+ - name: "offset"
+ in: "query"
+ required: false
+ type: "integer"
+ default: 0
+ format: "int64"
+ - name: "limit"
+ in: "query"
+ required: false
+ type: "integer"
+ default: 100
+ format: "int64"
+ - name: "accountWithBalance"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "accountWithBalanceAndCBA"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "audit"
+ in: "query"
required: false
type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
responses:
- "204":
- description: "Successful operation"
- "400":
- description: "Invalid account id supplied"
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/Account"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- delete:
+ /1.0/kb/accounts/{accountId}/emails:
+ get:
tags:
- "Account"
- summary: "Remove custom fields from account"
+ summary: "Retrieve an account emails"
description: ""
- operationId: "deleteAccountCustomFields"
- consumes:
- - "application/json"
+ operationId: "getEmails"
produces:
- "application/json"
parameters:
@@ -754,42 +654,27 @@ 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:
- "204":
- description: "Successful operation"
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/AccountEmail"
"400":
description: "Invalid account id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/block:
- get:
+ post:
tags:
- "Account"
- summary: "Retrieve blocking states for account"
+ summary: "Add account email"
description: ""
- operationId: "getBlockingStates"
+ operationId: "addEmail"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
@@ -799,53 +684,46 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "blockingStateTypes"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- enum:
- - "SUBSCRIPTION"
- - "SUBSCRIPTION_BUNDLE"
- - "ACCOUNT"
- collectionFormat: "multi"
- - name: "blockingStateSvcs"
- in: "query"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/AccountEmail"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "audit"
- in: "query"
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
required: false
type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
responses:
- "200":
- description: "successful operation"
+ "201":
+ description: "Email created successfully"
schema:
type: "array"
items:
- $ref: "#/definitions/BlockingState"
+ $ref: "#/definitions/AccountEmail"
"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}/emails/{email}:
+ delete:
tags:
- "Account"
- summary: "Block an account"
+ summary: "Delete email from account"
description: ""
- operationId: "addAccountBlockingState"
- consumes:
+ operationId: "removeEmail"
+ produces:
- "application/json"
parameters:
- name: "accountId"
@@ -854,23 +732,10 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - in: "body"
- name: "body"
+ - name: "email"
+ in: "path"
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
@@ -884,56 +749,73 @@ paths:
required: false
type: "string"
responses:
- "201":
- description: "Blocking state created successfully"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/BlockingState"
+ "204":
+ description: "Successful operation"
"400":
description: "Invalid account id supplied"
- "404":
- description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/auditLogs:
+ /1.0/kb/accounts/pagination:
get:
tags:
- "Account"
- summary: "Retrieve audit logs by account id"
+ summary: "List accounts"
description: ""
- operationId: "getAccountAuditLogs"
+ operationId: "getAccounts"
produces:
- "application/json"
parameters:
- - name: "accountId"
- in: "path"
- required: true
+ - name: "offset"
+ in: "query"
+ required: false
+ type: "integer"
+ default: 0
+ format: "int64"
+ - name: "limit"
+ in: "query"
+ required: false
+ type: "integer"
+ default: 100
+ format: "int64"
+ - name: "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"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
responses:
"200":
description: "successful operation"
schema:
type: "array"
items:
- $ref: "#/definitions/AuditLog"
- "404":
- description: "Account not found"
+ $ref: "#/definitions/Account"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/emails:
+ /1.0/kb/accounts/{accountId}:
get:
tags:
- "Account"
- summary: "Retrieve an account emails"
+ summary: "Retrieve an account by id"
description: ""
- operationId: "getEmails"
+ operationId: "getAccount"
produces:
- "application/json"
parameters:
@@ -943,25 +825,44 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ - name: "accountWithBalance"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "accountWithBalanceAndCBA"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "audit"
+ in: "query"
+ required: false
+ type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
responses:
"200":
description: "successful operation"
schema:
- type: "array"
- items:
- $ref: "#/definitions/AccountEmail"
+ $ref: "#/definitions/Account"
"400":
description: "Invalid account id supplied"
+ "404":
+ description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- post:
+ put:
tags:
- "Account"
- summary: "Add account email"
+ summary: "Update account"
description: ""
- operationId: "addEmail"
+ operationId: "updateAccount"
consumes:
- "application/json"
produces:
@@ -977,7 +878,12 @@ paths:
name: "body"
required: true
schema:
- $ref: "#/definitions/AccountEmail"
+ $ref: "#/definitions/Account"
+ - name: "treatNullAsReset"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -991,80 +897,49 @@ 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 data supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts:
- get:
+ delete:
tags:
- "Account"
- summary: "Retrieve an account by external key"
+ summary: "Close account"
description: ""
- operationId: "getAccountByKey"
+ operationId: "closeAccount"
produces:
- "application/json"
parameters:
- - name: "externalKey"
- in: "query"
+ - name: "accountId"
+ in: "path"
required: true
type: "string"
- - name: "accountWithBalance"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - name: "cancelAllSubscriptions"
in: "query"
required: false
type: "boolean"
default: false
- - name: "accountWithBalanceAndCBA"
+ - name: "writeOffUnpaidInvoices"
in: "query"
required: false
type: "boolean"
default: false
- - name: "audit"
+ - name: "itemAdjustUnpaidInvoices"
in: "query"
required: false
- type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
- responses:
- "200":
- description: "successful operation"
- schema:
- $ref: "#/definitions/Account"
- "404":
- description: "Account not found"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- post:
- tags:
- - "Account"
- summary: "Create account"
- description: ""
- operationId: "createAccount"
- consumes:
- - "application/json"
- produces:
- - "application/json"
- parameters:
- - in: "body"
- name: "body"
- required: true
- schema:
- $ref: "#/definitions/Account"
+ type: "boolean"
+ default: false
+ - name: "removeFutureNotifications"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: true
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -1078,43 +953,30 @@ paths:
required: false
type: "string"
responses:
- "201":
- description: "Account created successfully"
- schema:
- $ref: "#/definitions/Account"
+ "204":
+ description: "Successful operation"
"400":
- description: "Invalid account data supplied"
+ description: "Invalid account id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/search/{searchKey}:
+ /1.0/kb/accounts/{accountId}/children:
get:
tags:
- "Account"
- summary: "Search accounts"
+ summary: "List children accounts"
description: ""
- operationId: "searchAccounts"
+ operationId: "getChildrenAccounts"
produces:
- "application/json"
parameters:
- - name: "searchKey"
+ - name: "accountId"
in: "path"
required: true
type: "string"
- pattern: ".*"
- - name: "offset"
- in: "query"
- required: false
- type: "integer"
- default: 0
- format: "int64"
- - name: "limit"
- in: "query"
- required: false
- type: "integer"
- default: 100
- format: "int64"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
- name: "accountWithBalance"
in: "query"
required: false
@@ -1141,30 +1003,32 @@ paths:
type: "array"
items:
$ref: "#/definitions/Account"
+ "400":
+ description: "Invalid parent account id supplied"
+ "404":
+ description: "Parent Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/emails/{email}:
- delete:
+ /1.0/kb/accounts/{childAccountId}/transferCredit:
+ put:
tags:
- "Account"
- summary: "Delete email from account"
+ summary: "Move a given child credit to the parent level"
description: ""
- operationId: "removeEmail"
+ 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: "email"
- in: "path"
- required: true
- type: "string"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -1181,43 +1045,46 @@ paths:
"204":
description: "Successful operation"
"400":
- description: "Invalid account id supplied"
+ description: "Account does not have credit"
+ "404":
+ description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/pagination:
+ /1.0/kb/accounts/{accountId}/invoicePayments:
get:
tags:
- "Account"
- summary: "List accounts"
+ summary: "Retrieve account invoice payments"
description: ""
- operationId: "getAccounts"
+ operationId: "getInvoicePayments"
produces:
- "application/json"
parameters:
- - name: "offset"
- in: "query"
- required: false
- type: "integer"
- default: 0
- format: "int64"
- - name: "limit"
- in: "query"
- required: false
- type: "integer"
- default: 100
- format: "int64"
- - name: "accountWithBalance"
+ - name: "accountId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - name: "withPluginInfo"
in: "query"
required: false
type: "boolean"
default: false
- - name: "accountWithBalanceAndCBA"
+ - 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
@@ -1233,18 +1100,23 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/Account"
+ $ref: "#/definitions/InvoicePayment"
+ "400":
+ description: "Invalid account id supplied"
+ "404":
+ description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}:
- get:
+ post:
tags:
- "Account"
- summary: "Retrieve an account by id"
+ summary: "Trigger a payment for all unpaid invoices"
description: ""
- operationId: "getAccount"
+ operationId: "payAllInvoices"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
@@ -1254,44 +1126,66 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "accountWithBalance"
+ - name: "paymentMethodId"
in: "query"
required: false
- type: "boolean"
- default: false
- - name: "accountWithBalanceAndCBA"
+ type: "string"
+ format: "uuid"
+ - name: "externalPayment"
in: "query"
required: false
type: "boolean"
default: false
- - name: "audit"
+ - name: "paymentAmount"
+ in: "query"
+ required: false
+ type: "number"
+ - name: "targetDate"
in: "query"
required: false
type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
+ format: "date"
+ - name: "pluginProperty"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ required: false
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
+ required: false
+ type: "string"
responses:
- "200":
- description: "successful operation"
+ "201":
+ description: "Successful operation"
schema:
- $ref: "#/definitions/Account"
- "400":
- description: "Invalid account id supplied"
+ type: "array"
+ items:
+ $ref: "#/definitions/Invoice"
+ "204":
+ description: "Nothing to pay"
"404":
- description: "Account not found"
+ description: "Invalid account id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ /1.0/kb/accounts/{accountId}/paymentMethods/{paymentMethodId}/setDefault:
put:
tags:
- "Account"
- summary: "Update account"
+ summary: "Set the default payment method"
description: ""
- operationId: "updateAccount"
+ operationId: "setDefaultPaymentMethod"
consumes:
- "application/json"
produces:
@@ -1303,16 +1197,24 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - in: "body"
- name: "body"
+ - name: "paymentMethodId"
+ in: "path"
required: true
- schema:
- $ref: "#/definitions/Account"
- - name: "treatNullAsReset"
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - name: "payAllUnpaidInvoices"
in: "query"
required: false
type: "boolean"
default: false
+ - name: "pluginProperty"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -1329,17 +1231,20 @@ paths:
"204":
description: "Successful operation"
"400":
- description: "Invalid account data supplied"
+ description: "Invalid account id or payment method id supplied"
+ "404":
+ description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- delete:
- tags:
+ /1.0/kb/accounts/{accountId}/paymentMethods/refresh:
+ put:
+ tags:
- "Account"
- summary: "Close account"
+ summary: "Refresh account payment methods"
description: ""
- operationId: "closeAccount"
+ operationId: "refreshPaymentMethods"
produces:
- "application/json"
parameters:
@@ -1349,26 +1254,17 @@ 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"
+ - name: "pluginName"
in: "query"
required: false
- type: "boolean"
- default: false
- - name: "removeFutureNotifications"
+ type: "string"
+ - name: "pluginProperty"
in: "query"
required: false
- type: "boolean"
- default: true
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -1386,67 +1282,19 @@ paths:
description: "Successful operation"
"400":
description: "Invalid account id supplied"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/children:
- get:
- tags:
- - "Account"
- summary: "List children accounts"
- description: ""
- operationId: "getChildrenAccounts"
- produces:
- - "application/json"
- parameters:
- - name: "accountId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "accountWithBalance"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "accountWithBalanceAndCBA"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "audit"
- in: "query"
- required: false
- type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
- responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/Account"
- "400":
- description: "Invalid parent account id supplied"
"404":
- description: "Parent Account not found"
+ description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/invoicePayments:
+ /1.0/kb/accounts/{accountId}/paymentMethods:
get:
tags:
- "Account"
- summary: "Retrieve account invoice payments"
+ summary: "Retrieve account payment methods"
description: ""
- operationId: "getInvoicePayments"
+ operationId: "getPaymentMethodsForAccount"
produces:
- "application/json"
parameters:
@@ -1461,7 +1309,7 @@ paths:
required: false
type: "boolean"
default: false
- - name: "withAttempts"
+ - name: "includedDeleted"
in: "query"
required: false
type: "boolean"
@@ -1488,7 +1336,7 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/InvoicePayment"
+ $ref: "#/definitions/PaymentMethod"
"400":
description: "Invalid account id supplied"
"404":
@@ -1500,9 +1348,9 @@ paths:
post:
tags:
- "Account"
- summary: "Trigger a payment for all unpaid invoices"
+ summary: "Add a payment method"
description: ""
- operationId: "payAllInvoices"
+ operationId: "createPaymentMethod"
consumes:
- "application/json"
produces:
@@ -1514,25 +1362,28 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "paymentMethodId"
- in: "query"
- required: false
- type: "string"
- format: "uuid"
- - name: "externalPayment"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/PaymentMethod"
+ - name: "isDefault"
in: "query"
required: false
type: "boolean"
default: false
- - name: "paymentAmount"
+ - name: "payAllUnpaidInvoices"
in: "query"
required: false
- type: "number"
- - name: "targetDate"
+ type: "boolean"
+ default: false
+ - name: "controlPluginName"
in: "query"
required: false
- type: "string"
- format: "date"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
- name: "pluginProperty"
in: "query"
required: false
@@ -1554,28 +1405,24 @@ paths:
type: "string"
responses:
"201":
- description: "Successful operation"
+ description: "Payment method created"
schema:
- type: "array"
- items:
- $ref: "#/definitions/Invoice"
- "204":
- description: "Nothing to pay"
- "404":
+ $ref: "#/definitions/PaymentMethod"
+ "400":
description: "Invalid account id supplied"
+ "404":
+ description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/paymentMethods/{paymentMethodId}/setDefault:
- put:
+ /1.0/kb/accounts/{accountId}/auditLogsWithHistory:
+ get:
tags:
- "Account"
- summary: "Set the default payment method"
+ summary: "Retrieve account audit logs with history by account id"
description: ""
- operationId: "setDefaultPaymentMethod"
- consumes:
- - "application/json"
+ operationId: "getAccountAuditLogsWithHistory"
produces:
- "application/json"
parameters:
@@ -1585,54 +1432,26 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "paymentMethodId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "payAllUnpaidInvoices"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
responses:
- "204":
- description: "Successful operation"
- "400":
- description: "Invalid account id or payment method 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: []
- /1.0/kb/accounts/{accountId}/paymentMethods/refresh:
- put:
+ /1.0/kb/accounts/{accountId}/bundles:
+ get:
tags:
- "Account"
- summary: "Refresh account payment methods"
+ summary: "Retrieve bundles for account"
description: ""
- operationId: "refreshPaymentMethods"
+ operationId: "getAccountBundles"
produces:
- "application/json"
parameters:
@@ -1642,32 +1461,30 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "pluginName"
+ - name: "externalKey"
in: "query"
required: false
type: "string"
- - name: "pluginProperty"
+ - name: "bundlesFilter"
in: "query"
required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
+ - name: "audit"
+ in: "query"
required: false
type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
responses:
- "204":
- description: "Successful operation"
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/Bundle"
"400":
description: "Invalid account id supplied"
"404":
@@ -1676,13 +1493,13 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/allTags:
+ /1.0/kb/accounts/{accountId}/bundles/pagination:
get:
tags:
- "Account"
- summary: "Retrieve account tags"
+ summary: "Retrieve paginated bundles for account"
description: ""
- operationId: "getAllTags"
+ operationId: "getAccountBundlesPaginated"
produces:
- "application/json"
parameters:
@@ -1692,35 +1509,18 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "objectType"
+ - name: "offset"
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: "integer"
+ default: 0
+ format: "int64"
+ - name: "limit"
in: "query"
required: false
- type: "boolean"
- default: false
+ type: "integer"
+ default: 100
+ format: "int64"
- name: "audit"
in: "query"
required: false
@@ -1736,7 +1536,7 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/Tag"
+ $ref: "#/definitions/Bundle"
"400":
description: "Invalid account id supplied"
"404":
@@ -1745,13 +1545,13 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/bundles:
+ /1.0/kb/accounts/{accountId}/emails/{accountEmailId}/auditLogsWithHistory:
get:
tags:
- "Account"
- summary: "Retrieve bundles for account"
+ summary: "Retrieve account email audit logs with history by id"
description: ""
- operationId: "getAccountBundles"
+ operationId: "getAccountEmailAuditLogsWithHistory"
produces:
- "application/json"
parameters:
@@ -1761,45 +1561,32 @@ paths:
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
+ - name: "accountEmailId"
+ in: "path"
+ required: true
type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
responses:
"200":
description: "successful operation"
schema:
type: "array"
items:
- $ref: "#/definitions/Bundle"
- "400":
- description: "Invalid account id supplied"
+ $ref: "#/definitions/AuditLog"
"404":
description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/bundles/pagination:
+ /1.0/kb/accounts/{accountId}/timeline:
get:
tags:
- "Account"
- summary: "Retrieve paginated bundles for account"
+ summary: "Retrieve account timeline"
description: ""
- operationId: "getAccountBundlesPaginated"
+ operationId: "getAccountTimeline"
produces:
- "application/json"
parameters:
@@ -1809,18 +1596,11 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "offset"
- in: "query"
- required: false
- type: "integer"
- default: 0
- format: "int64"
- - name: "limit"
+ - name: "parallel"
in: "query"
required: false
- type: "integer"
- default: 100
- format: "int64"
+ type: "boolean"
+ default: false
- name: "audit"
in: "query"
required: false
@@ -1834,9 +1614,7 @@ paths:
"200":
description: "successful operation"
schema:
- type: "array"
- items:
- $ref: "#/definitions/Bundle"
+ $ref: "#/definitions/AccountTimeline"
"400":
description: "Invalid account id supplied"
"404":
@@ -1845,13 +1623,13 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/timeline:
+ /1.0/kb/accounts/{accountId}/allCustomFields:
get:
tags:
- "Account"
- summary: "Retrieve account timeline"
+ summary: "Retrieve account customFields"
description: ""
- operationId: "getAccountTimeline"
+ operationId: "getAllCustomFields"
produces:
- "application/json"
parameters:
@@ -1861,11 +1639,30 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "parallel"
+ - name: "objectType"
in: "query"
required: false
- type: "boolean"
- default: false
+ type: "string"
+ enum:
+ - "ACCOUNT"
+ - "ACCOUNT_EMAIL"
+ - "BLOCKING_STATES"
+ - "BUNDLE"
+ - "CUSTOM_FIELD"
+ - "INVOICE"
+ - "PAYMENT"
+ - "TRANSACTION"
+ - "INVOICE_ITEM"
+ - "INVOICE_PAYMENT"
+ - "SUBSCRIPTION"
+ - "SUBSCRIPTION_EVENT"
+ - "SERVICE_BROADCAST"
+ - "PAYMENT_ATTEMPT"
+ - "PAYMENT_METHOD"
+ - "TAG"
+ - "TAG_DEFINITION"
+ - "TENANT"
+ - "TENANT_KVS"
- name: "audit"
in: "query"
required: false
@@ -1879,7 +1676,9 @@ paths:
"200":
description: "successful operation"
schema:
- $ref: "#/definitions/AccountTimeline"
+ type: "array"
+ items:
+ $ref: "#/definitions/CustomField"
"400":
description: "Invalid account id supplied"
"404":
@@ -1888,13 +1687,13 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/accounts/{accountId}/allCustomFields:
+ /1.0/kb/accounts/{accountId}/allTags:
get:
tags:
- "Account"
- summary: "Retrieve account customFields"
+ summary: "Retrieve account tags"
description: ""
- operationId: "getAllCustomFields"
+ operationId: "getAllTags"
produces:
- "application/json"
parameters:
@@ -1928,6 +1727,11 @@ paths:
- "TAG_DEFINITION"
- "TENANT"
- "TENANT_KVS"
+ - name: "includedDeleted"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
- name: "audit"
in: "query"
required: false
@@ -1943,7 +1747,7 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/CustomField"
+ $ref: "#/definitions/Tag"
"400":
description: "Invalid account id supplied"
"404":
@@ -1952,6 +1756,35 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ /1.0/kb/accounts/block/{blockingId}/auditLogsWithHistory:
+ get:
+ tags:
+ - "Account"
+ summary: "Retrieve blocking state audit logs with history by id"
+ description: ""
+ operationId: "getBlockingStateAuditLogsWithHistory"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "blockingId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/AuditLog"
+ "404":
+ description: "Blocking state not found"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
/1.0/kb/accounts/{accountId}/invoices:
get:
tags:
@@ -2026,6 +1859,58 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ /1.0/kb/accounts/{accountId}/invoices/pagination:
+ get:
+ tags:
+ - "Account"
+ summary: "Retrieve paginated invoices for account"
+ description: ""
+ operationId: "getInvoicesForAccountPaginated"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "accountId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - 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"
+ "400":
+ description: "Invalid account id supplied"
+ "404":
+ description: "Account not found"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
/1.0/kb/accounts/{accountId}/overdue:
get:
tags:
@@ -2186,30 +2071,40 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/admin/invoices:
+ /1.0/kb/accounts/payments:
post:
tags:
- - "Admin"
- summary: "Trigger an invoice generation for all parked accounts"
+ - "Account"
+ summary: "Trigger a payment using the account external key (authorization, purchase\
+ \ or credit)"
description: ""
- operationId: "triggerInvoiceGenerationForParkedAccounts"
+ operationId: "processPaymentByExternalKey"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- - name: "offset"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/PaymentTransaction"
+ - name: "externalKey"
+ in: "query"
+ required: true
+ type: "string"
+ - name: "paymentMethodId"
in: "query"
required: false
- type: "integer"
- default: 0
- format: "int64"
- - name: "limit"
+ type: "string"
+ format: "uuid"
+ - name: "controlPluginName"
in: "query"
required: false
- type: "integer"
- default: 100
- format: "int64"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
- name: "pluginProperty"
in: "query"
required: false
@@ -2230,41 +2125,46 @@ paths:
required: false
type: "string"
responses:
- "200":
- description: "Successful operation"
+ "201":
+ description: "Payment transaction created successfully"
+ schema:
+ $ref: "#/definitions/Payment"
+ "400":
+ description: "Invalid account external key supplied"
+ "404":
+ description: "Account not found"
+ "402":
+ description: "Transaction declined by gateway"
+ "422":
+ description: "Payment is aborted by a control plugin"
+ "502":
+ description: "Failed to submit payment transaction"
+ "503":
+ description: "Payment in unknown status, failed to receive gateway response"
+ "504":
+ description: "Payment operation timeout"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/admin/payments/{paymentId}/transactions/{paymentTransactionId}:
+ /1.0/kb/accounts/{accountId}/cbaRebalancing:
put:
tags:
- - "Admin"
- summary: "Update existing paymentTransaction and associated payment state"
+ - "Account"
+ summary: "Rebalance account CBA"
description: ""
- operationId: "updatePaymentTransactionState"
+ operationId: "rebalanceExistingCBAOnAccount"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- - name: "paymentId"
+ - name: "accountId"
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
@@ -2281,7 +2181,7 @@ paths:
"204":
description: "Successful operation"
"400":
- description: "Invalid account data supplied"
+ description: "Invalid account id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -2319,6 +2219,56 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ /1.0/kb/admin/payments/{paymentId}/transactions/{paymentTransactionId}:
+ put:
+ tags:
+ - "Admin"
+ summary: "Update existing paymentTransaction and associated payment state"
+ description: ""
+ operationId: "updatePaymentTransactionState"
+ consumes:
+ - "application/json"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "paymentId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - name: "paymentTransactionId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/AdminPayment"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ required: false
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
+ required: false
+ type: "string"
+ responses:
+ "204":
+ description: "Successful operation"
+ "400":
+ description: "Invalid account data supplied"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
/1.0/kb/admin/queues:
get:
tags:
@@ -2447,31 +2397,52 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/bundles/{bundleId}/auditLogsWithHistory:
- get:
+ /1.0/kb/admin/invoices:
+ post:
tags:
- - "Bundle"
- summary: "Retrieve bundle audit logs with history by id"
+ - "Admin"
+ summary: "Trigger an invoice generation for all parked accounts"
description: ""
- operationId: "getBundleAuditLogsWithHistory"
+ operationId: "triggerInvoiceGenerationForParkedAccounts"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
- - name: "bundleId"
- in: "path"
+ - name: "offset"
+ in: "query"
+ required: false
+ type: "integer"
+ default: 0
+ format: "int64"
+ - name: "limit"
+ in: "query"
+ required: false
+ type: "integer"
+ default: 100
+ format: "int64"
+ - name: "pluginProperty"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
required: true
type: "string"
- 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"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
- "404":
- description: "Subscription bundle not found"
+ description: "Successful operation"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -2911,28 +2882,25 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/bundles/pagination:
+ /1.0/kb/bundles:
get:
tags:
- "Bundle"
- summary: "List bundles"
+ summary: "Retrieve a bundle by external key"
description: ""
- operationId: "getBundles"
+ operationId: "getBundleByKey"
produces:
- "application/json"
parameters:
- - name: "offset"
+ - name: "externalKey"
in: "query"
- required: false
- type: "integer"
- default: 0
- format: "int64"
- - name: "limit"
+ required: true
+ type: "string"
+ - name: "includedDeleted"
in: "query"
required: false
- type: "integer"
- default: 100
- format: "int64"
+ type: "boolean"
+ default: false
- name: "audit"
in: "query"
required: false
@@ -2949,89 +2917,34 @@ paths:
type: "array"
items:
$ref: "#/definitions/Bundle"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/bundles/{bundleId}/block:
- post:
- tags:
- - "Bundle"
- summary: "Block a bundle"
- description: ""
- operationId: "addBundleBlockingState"
- consumes:
- - "application/json"
- parameters:
- - name: "bundleId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- $ref: "#/definitions/BlockingState"
- - name: "requestedDate"
- in: "query"
- required: false
- type: "string"
- format: "date"
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
- responses:
- "201":
- description: "Blocking state created successfully"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/BlockingState"
- "400":
- description: "Invalid bundle id supplied"
"404":
description: "Bundle not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/bundles:
+ /1.0/kb/bundles/pagination:
get:
tags:
- "Bundle"
- summary: "Retrieve a bundle by external key"
+ summary: "List bundles"
description: ""
- operationId: "getBundleByKey"
+ operationId: "getBundles"
produces:
- "application/json"
parameters:
- - name: "externalKey"
+ - name: "offset"
in: "query"
- required: true
- type: "string"
- - name: "includedDeleted"
+ required: false
+ type: "integer"
+ default: 0
+ format: "int64"
+ - name: "limit"
in: "query"
required: false
- type: "boolean"
- default: false
+ type: "integer"
+ default: 100
+ format: "int64"
- name: "audit"
in: "query"
required: false
@@ -3048,8 +2961,6 @@ paths:
type: "array"
items:
$ref: "#/definitions/Bundle"
- "404":
- description: "Bundle not found"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -3251,118 +3162,91 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/catalog/phase:
- get:
+ /1.0/kb/bundles/{bundleId}/block:
+ post:
tags:
- - "Catalog"
- summary: "Retrieve phase for a given subscription and date"
+ - "Bundle"
+ summary: "Block a bundle"
description: ""
- operationId: "getPhaseForSubscriptionAndDate"
- produces:
+ operationId: "addBundleBlockingState"
+ consumes:
- "application/json"
parameters:
- - name: "subscriptionId"
- in: "query"
- required: false
+ - name: "bundleId"
+ in: "path"
+ required: true
type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/BlockingState"
- name: "requestedDate"
in: "query"
required: false
type: "string"
format: "date"
- responses:
- "200":
- description: "successful operation"
- schema:
- $ref: "#/definitions/Phase"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/catalog/plan:
- get:
- tags:
- - "Catalog"
- summary: "Retrieve plan for a given subscription and date"
- description: ""
- operationId: "getPlanForSubscriptionAndDate"
- produces:
- - "application/json"
- parameters:
- - name: "subscriptionId"
- in: "query"
- required: false
- type: "string"
- format: "uuid"
- - name: "requestedDate"
+ - name: "pluginProperty"
in: "query"
required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
type: "string"
- format: "date"
- responses:
- "200":
- description: "successful operation"
- schema:
- $ref: "#/definitions/Plan"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/catalog/priceList:
- get:
- tags:
- - "Catalog"
- summary: "Retrieve priceList for a given subscription and date"
- description: ""
- operationId: "getPriceListForSubscriptionAndDate"
- produces:
- - "application/json"
- parameters:
- - name: "subscriptionId"
- in: "query"
+ - name: "X-Killbill-Reason"
+ in: "header"
required: false
type: "string"
- format: "uuid"
- - name: "requestedDate"
- in: "query"
+ - name: "X-Killbill-Comment"
+ in: "header"
required: false
type: "string"
- format: "date"
responses:
- "200":
- description: "successful operation"
+ "201":
+ description: "Blocking state created successfully"
schema:
- $ref: "#/definitions/PriceList"
+ type: "array"
+ items:
+ $ref: "#/definitions/BlockingState"
+ "400":
+ description: "Invalid bundle id supplied"
+ "404":
+ description: "Bundle not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/catalog/product:
+ /1.0/kb/bundles/{bundleId}/auditLogsWithHistory:
get:
tags:
- - "Catalog"
- summary: "Retrieve product for a given subscription and date"
+ - "Bundle"
+ summary: "Retrieve bundle audit logs with history by id"
description: ""
- operationId: "getProductForSubscriptionAndDate"
+ operationId: "getBundleAuditLogsWithHistory"
produces:
- "application/json"
parameters:
- - name: "subscriptionId"
- in: "query"
- required: false
+ - name: "bundleId"
+ in: "path"
+ required: true
type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "requestedDate"
- in: "query"
- required: false
- type: "string"
- format: "date"
responses:
"200":
description: "successful operation"
schema:
- $ref: "#/definitions/Product"
+ type: "array"
+ items:
+ $ref: "#/definitions/AuditLog"
+ "404":
+ description: "Subscription bundle not found"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -3613,6 +3497,122 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ /1.0/kb/catalog/phase:
+ get:
+ tags:
+ - "Catalog"
+ summary: "Retrieve phase for a given subscription and date"
+ description: ""
+ operationId: "getPhaseForSubscriptionAndDate"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "subscriptionId"
+ in: "query"
+ required: false
+ type: "string"
+ format: "uuid"
+ - name: "requestedDate"
+ in: "query"
+ required: false
+ type: "string"
+ format: "date"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ $ref: "#/definitions/Phase"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ /1.0/kb/catalog/plan:
+ get:
+ tags:
+ - "Catalog"
+ summary: "Retrieve plan for a given subscription and date"
+ description: ""
+ operationId: "getPlanForSubscriptionAndDate"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "subscriptionId"
+ in: "query"
+ required: false
+ type: "string"
+ format: "uuid"
+ - name: "requestedDate"
+ in: "query"
+ required: false
+ type: "string"
+ format: "date"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ $ref: "#/definitions/Plan"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ /1.0/kb/catalog/priceList:
+ get:
+ tags:
+ - "Catalog"
+ summary: "Retrieve priceList for a given subscription and date"
+ description: ""
+ operationId: "getPriceListForSubscriptionAndDate"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "subscriptionId"
+ in: "query"
+ required: false
+ type: "string"
+ format: "uuid"
+ - name: "requestedDate"
+ in: "query"
+ required: false
+ type: "string"
+ format: "date"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ $ref: "#/definitions/PriceList"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ /1.0/kb/catalog/product:
+ get:
+ tags:
+ - "Catalog"
+ summary: "Retrieve product for a given subscription and date"
+ description: ""
+ operationId: "getProductForSubscriptionAndDate"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "subscriptionId"
+ in: "query"
+ required: false
+ type: "string"
+ format: "uuid"
+ - name: "requestedDate"
+ in: "query"
+ required: false
+ type: "string"
+ format: "date"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ $ref: "#/definitions/Product"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
/1.0/kb/catalog/xml/validate:
post:
tags:
@@ -3651,35 +3651,6 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/credits/{creditId}:
- get:
- tags:
- - "Credit"
- summary: "Retrieve a credit by id"
- description: ""
- operationId: "getCredit"
- produces:
- - "application/json"
- parameters:
- - name: "creditId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- responses:
- "200":
- description: "successful operation"
- schema:
- $ref: "#/definitions/InvoiceItem"
- "400":
- description: "Invalid credit id supplied"
- "404":
- description: "Credit not found"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
/1.0/kb/credits:
post:
tags:
@@ -3699,6 +3670,11 @@ paths:
type: "array"
items:
$ref: "#/definitions/InvoiceItem"
+ - name: "requestedDate"
+ in: "query"
+ required: false
+ type: "string"
+ format: "date"
- name: "autoCommit"
in: "query"
required: false
@@ -3738,17 +3714,17 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/customFields/{customFieldId}/auditLogsWithHistory:
+ /1.0/kb/credits/{creditId}:
get:
tags:
- - "CustomField"
- summary: "Retrieve custom field audit logs with history by id"
+ - "Credit"
+ summary: "Retrieve a credit by id"
description: ""
- operationId: "getCustomFieldAuditLogsWithHistory"
+ operationId: "getCredit"
produces:
- "application/json"
parameters:
- - name: "customFieldId"
+ - name: "creditId"
in: "path"
required: true
type: "string"
@@ -3758,37 +3734,25 @@ paths:
"200":
description: "successful operation"
schema:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
+ $ref: "#/definitions/InvoiceItem"
+ "400":
+ description: "Invalid credit id supplied"
"404":
- description: "Account not found"
+ description: "Credit not found"
security:
- 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
@@ -3821,16 +3785,21 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/customFields/pagination:
+ /1.0/kb/customFields/search/{searchKey}:
get:
tags:
- "CustomField"
- summary: "List custom fields"
+ summary: "Search custom fields"
description: ""
- operationId: "getCustomFields"
+ operationId: "searchCustomFields"
produces:
- "application/json"
parameters:
+ - name: "searchKey"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: ".*"
- name: "offset"
in: "query"
required: false
@@ -3863,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
@@ -3949,6 +3954,152 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ /1.0/kb/invoiceItems/{invoiceItemId}/tags:
+ get:
+ tags:
+ - "InvoiceItem"
+ summary: "Retrieve invoice item tags"
+ description: ""
+ operationId: "getInvoiceItemTags"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "invoiceItemId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - name: "accountId"
+ in: "query"
+ required: true
+ type: "string"
+ format: "uuid"
+ - name: "includedDeleted"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "audit"
+ in: "query"
+ required: false
+ type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/Tag"
+ "400":
+ description: "Invalid invoice item id supplied"
+ "404":
+ description: "Account not found"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ post:
+ tags:
+ - "InvoiceItem"
+ summary: "Add tags to invoice item"
+ description: ""
+ operationId: "createInvoiceItemTags"
+ 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:
+ type: "string"
+ format: "uuid"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ required: false
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
+ required: false
+ type: "string"
+ responses:
+ "201":
+ description: "Tag created successfully"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/Tag"
+ "400":
+ description: "Invalid invoice item id supplied"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ delete:
+ tags:
+ - "InvoiceItem"
+ summary: "Remove tags from invoice item"
+ description: ""
+ operationId: "deleteInvoiceItemTags"
+ consumes:
+ - "application/json"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "invoiceItemId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - name: "tagDef"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ format: "uuid"
+ collectionFormat: "multi"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ required: false
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
+ required: false
+ type: "string"
+ responses:
+ "204":
+ description: "Successful operation"
+ "400":
+ description: "Invalid invoice item id supplied"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
/1.0/kb/invoiceItems/{invoiceItemId}/customFields:
get:
tags:
@@ -4156,32 +4307,34 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoiceItems/{invoiceItemId}/tags:
+ /1.0/kb/invoicePayments/{paymentId}/tags:
get:
tags:
- - "InvoiceItem"
- summary: "Retrieve invoice item tags"
+ - "InvoicePayment"
+ summary: "Retrieve payment tags"
description: ""
- operationId: "getInvoiceItemTags"
+ operationId: "getInvoicePaymentTags"
produces:
- "application/json"
parameters:
- - name: "invoiceItemId"
+ - name: "paymentId"
in: "path"
required: true
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "accountId"
- in: "query"
- required: true
- type: "string"
- format: "uuid"
- name: "includedDeleted"
in: "query"
required: false
type: "boolean"
default: false
+ - name: "pluginProperty"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
- name: "audit"
in: "query"
required: false
@@ -4199,25 +4352,25 @@ paths:
items:
$ref: "#/definitions/Tag"
"400":
- description: "Invalid invoice item id supplied"
+ description: "Invalid payment id supplied"
"404":
- description: "Account not found"
+ description: "Payment not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
post:
tags:
- - "InvoiceItem"
- summary: "Add tags to invoice item"
+ - "InvoicePayment"
+ summary: "Add tags to payment"
description: ""
- operationId: "createInvoiceItemTags"
+ operationId: "createInvoicePaymentTags"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- - name: "invoiceItemId"
+ - name: "paymentId"
in: "path"
required: true
type: "string"
@@ -4251,118 +4404,17 @@ paths:
items:
$ref: "#/definitions/Tag"
"400":
- description: "Invalid invoice item id supplied"
+ description: "Invalid payment id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
delete:
- tags:
- - "InvoiceItem"
- summary: "Remove tags from invoice item"
- description: ""
- operationId: "deleteInvoiceItemTags"
- consumes:
- - "application/json"
- produces:
- - "application/json"
- parameters:
- - name: "invoiceItemId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "tagDef"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- format: "uuid"
- collectionFormat: "multi"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
- responses:
- "204":
- description: "Successful operation"
- "400":
- description: "Invalid invoice item id supplied"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/invoicePayments/{paymentId}:
- get:
- tags:
- - "InvoicePayment"
- summary: "Retrieve a payment by id"
- description: ""
- operationId: "getInvoicePayment"
- 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/InvoicePayment"
- "400":
- description: "Invalid payment id supplied"
- "404":
- description: "Payment not found"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- put:
tags:
- "InvoicePayment"
- summary: "Complete an existing transaction"
+ summary: "Remove tags from payment"
description: ""
- operationId: "completeInvoicePaymentTransaction"
+ operationId: "deleteInvoicePaymentTags"
consumes:
- "application/json"
produces:
@@ -4374,24 +4426,13 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- $ref: "#/definitions/PaymentTransaction"
- - name: "controlPluginName"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "pluginProperty"
+ - name: "tagDef"
in: "query"
required: false
type: "array"
items:
type: "string"
+ format: "uuid"
collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
@@ -4409,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: []
@@ -4604,15 +4633,13 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoicePayments/{paymentId}/refunds:
- post:
+ /1.0/kb/invoicePayments/{paymentId}:
+ get:
tags:
- "InvoicePayment"
- summary: "Refund a payment, and adjust the invoice if needed"
+ summary: "Retrieve a payment by id"
description: ""
- operationId: "createRefundWithAdjustments"
- consumes:
- - "application/json"
+ operationId: "getInvoicePayment"
produces:
- "application/json"
parameters:
@@ -4622,99 +4649,12 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- $ref: "#/definitions/InvoicePaymentTransaction"
- - name: "externalPayment"
+ - name: "withPluginInfo"
in: "query"
required: false
type: "boolean"
default: false
- - name: "paymentMethodId"
- in: "query"
- required: false
- type: "string"
- format: "uuid"
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
- responses:
- "201":
- description: "Created refund 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/{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}/tags:
- get:
- tags:
- - "InvoicePayment"
- summary: "Retrieve payment tags"
- description: ""
- operationId: "getInvoicePaymentTags"
- produces:
- - "application/json"
- parameters:
- - name: "paymentId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "includedDeleted"
+ - name: "withAttempts"
in: "query"
required: false
type: "boolean"
@@ -4739,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":
@@ -4750,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:
@@ -4771,41 +4709,61 @@ paths:
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"
+ $ref: "#/definitions/PaymentTransaction"
+ - name: "controlPluginName"
+ in: "query"
required: false
- type: "string"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ - name: "pluginProperty"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ required: false
+ type: "string"
- name: "X-Killbill-Comment"
in: "header"
required: false
type: "string"
responses:
- "201":
- description: "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:
@@ -4817,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"
@@ -4838,21 +4800,25 @@ paths:
required: false
type: "string"
responses:
- "204":
- description: "Successful operation"
+ "201":
+ description: "Created chargeback successfully"
+ schema:
+ $ref: "#/definitions/InvoicePayment"
"400":
description: "Invalid payment id supplied"
+ "404":
+ description: "Account or payment not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoicePayments/{paymentId}/chargebacks:
+ /1.0/kb/invoicePayments/{paymentId}/chargebackReversals:
post:
tags:
- "InvoicePayment"
- summary: "Record a chargeback"
+ summary: "Record a chargebackReversal"
description: ""
- operationId: "createChargeback"
+ operationId: "createChargebackReversal"
consumes:
- "application/json"
produces:
@@ -4890,7 +4856,7 @@ paths:
type: "string"
responses:
"201":
- description: "Created chargeback successfully"
+ description: "Created chargeback reversal successfully"
schema:
$ref: "#/definitions/InvoicePayment"
"400":
@@ -4901,13 +4867,13 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoicePayments/{paymentId}/chargebackReversals:
+ /1.0/kb/invoicePayments/{paymentId}/refunds:
post:
tags:
- "InvoicePayment"
- summary: "Record a chargebackReversal"
+ summary: "Refund a payment, and adjust the invoice if needed"
description: ""
- operationId: "createChargebackReversal"
+ operationId: "createRefundWithAdjustments"
consumes:
- "application/json"
produces:
@@ -4924,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
@@ -4945,7 +4921,7 @@ paths:
type: "string"
responses:
"201":
- description: "Created chargeback reversal successfully"
+ description: "Created refund successfully"
schema:
$ref: "#/definitions/InvoicePayment"
"400":
@@ -4956,17 +4932,17 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoices/{invoiceId}/auditLogsWithHistory:
+ /1.0/kb/invoicePayments/{invoicePaymentId}/auditLogsWithHistory:
get:
tags:
- - "Invoice"
- summary: "Retrieve invoice audit logs with history by id"
+ - "InvoicePayment"
+ summary: "Retrieve invoice payment audit logs with history by id"
description: ""
- operationId: "getInvoiceAuditLogsWithHistory"
+ operationId: "getInvoicePaymentAuditLogsWithHistory"
produces:
- "application/json"
parameters:
- - name: "invoiceId"
+ - name: "invoicePaymentId"
in: "path"
required: true
type: "string"
@@ -4980,7 +4956,7 @@ paths:
items:
$ref: "#/definitions/AuditLog"
"404":
- description: "Invoice not found"
+ description: "Invoice payment not found"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -5473,22 +5449,22 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoices/byNumber/{invoiceNumber}:
+ /1.0/kb/invoices/{invoiceId}:
get:
tags:
- "Invoice"
- summary: "Retrieve an invoice by number"
+ summary: "Retrieve an invoice by id"
description: ""
- operationId: "getInvoiceByNumber"
+ operationId: "getInvoice"
produces:
- "application/json"
parameters:
- - name: "invoiceNumber"
+ - name: "invoiceId"
in: "path"
required: true
- type: "integer"
- pattern: "[0-9]+"
- format: "int32"
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
- name: "withChildrenItems"
in: "query"
required: false
@@ -5508,52 +5484,26 @@ paths:
description: "successful operation"
schema:
$ref: "#/definitions/Invoice"
+ "400":
+ description: "Invalid invoice id supplied"
"404":
description: "Invoice not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoices/{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/migration/{accountId}:
post:
tags:
- "Invoice"
- summary: "Create a migration invoice"
+ summary: "Adjust an invoice item"
description: ""
- operationId: "createMigrationInvoice"
+ operationId: "adjustInvoiceItem"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- - name: "accountId"
+ - name: "invoiceId"
in: "path"
required: true
type: "string"
@@ -5563,14 +5513,19 @@ paths:
name: "body"
required: true
schema:
- type: "array"
- items:
- $ref: "#/definitions/InvoiceItem"
- - name: "targetDate"
+ $ref: "#/definitions/InvoiceItem"
+ - name: "requestedDate"
in: "query"
required: false
type: "string"
format: "date"
+ - name: "pluginProperty"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -5585,31 +5540,33 @@ paths:
type: "string"
responses:
"201":
- description: "Created migration invoice successfully"
+ description: "Created adjustment Successfully"
schema:
$ref: "#/definitions/Invoice"
"400":
- description: "Invalid account id or target datetime supplied"
+ description: "Invalid account id, invoice id or invoice item id supplied"
+ "404":
+ description: "Invoice not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoices/{invoiceId}:
+ /1.0/kb/invoices/byNumber/{invoiceNumber}:
get:
tags:
- "Invoice"
- summary: "Retrieve an invoice by id"
+ summary: "Retrieve an invoice by number"
description: ""
- operationId: "getInvoice"
+ operationId: "getInvoiceByNumber"
produces:
- "application/json"
parameters:
- - name: "invoiceId"
+ - name: "invoiceNumber"
in: "path"
required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
+ type: "integer"
+ pattern: "[0-9]+"
+ format: "int32"
- name: "withChildrenItems"
in: "query"
required: false
@@ -5629,67 +5586,6 @@ paths:
description: "successful operation"
schema:
$ref: "#/definitions/Invoice"
- "400":
- description: "Invalid invoice id supplied"
- "404":
- description: "Invoice not found"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- post:
- tags:
- - "Invoice"
- summary: "Adjust an invoice item"
- description: ""
- operationId: "adjustInvoiceItem"
- consumes:
- - "application/json"
- produces:
- - "application/json"
- parameters:
- - name: "invoiceId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- $ref: "#/definitions/InvoiceItem"
- - name: "requestedDate"
- in: "query"
- required: false
- type: "string"
- format: "date"
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
- responses:
- "201":
- description: "Created adjustment Successfully"
- schema:
- $ref: "#/definitions/Invoice"
- "400":
- description: "Invalid account id, invoice id or invoice item id supplied"
"404":
description: "Invoice not found"
security:
@@ -5748,15 +5644,95 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/invoices/charges/{accountId}:
- post:
+ /1.0/kb/invoices/{invoiceId}/html:
+ get:
tags:
- "Invoice"
- summary: "Create external charge(s)"
+ summary: "Render an invoice as HTML"
description: ""
- operationId: "createExternalCharges"
- consumes:
- - "application/json"
+ 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/migration/{accountId}:
+ post:
+ tags:
+ - "Invoice"
+ summary: "Create a migration invoice"
+ description: ""
+ operationId: "createMigrationInvoice"
+ consumes:
+ - "application/json"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "accountId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/InvoiceItem"
+ - name: "targetDate"
+ in: "query"
+ required: false
+ type: "string"
+ format: "date"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ required: false
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
+ required: false
+ type: "string"
+ responses:
+ "201":
+ description: "Created migration invoice successfully"
+ schema:
+ $ref: "#/definitions/Invoice"
+ "400":
+ description: "Invalid account id or target datetime supplied"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ /1.0/kb/invoices/charges/{accountId}:
+ post:
+ tags:
+ - "Invoice"
+ summary: "Create external charge(s)"
+ description: ""
+ operationId: "createExternalCharges"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
@@ -6244,6 +6220,35 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ /1.0/kb/invoices/{invoiceId}/auditLogsWithHistory:
+ get:
+ tags:
+ - "Invoice"
+ summary: "Retrieve invoice audit logs with history by id"
+ description: ""
+ operationId: "getInvoiceAuditLogsWithHistory"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "invoiceId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/AuditLog"
+ "404":
+ description: "Invoice not found"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
/1.0/kb/invoices/byItemId/{itemId}:
get:
tags:
@@ -7065,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:
@@ -7325,6 +7301,35 @@ 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:
get:
tags:
@@ -7376,61 +7381,76 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/cancelScheduledPaymentTransaction:
- delete:
+ /1.0/kb/payments/{paymentId}/tags:
+ get:
tags:
- "Payment"
- summary: "Cancels a scheduled payment attempt retry"
+ summary: "Retrieve payment payment tags"
description: ""
- operationId: "cancelScheduledPaymentTransactionByExternalKey"
- consumes:
- - "application/json"
+ operationId: "getPaymentTags"
produces:
- "application/json"
parameters:
- - name: "transactionExternalKey"
- in: "query"
- required: true
- type: "string"
- - name: "X-Killbill-CreatedBy"
- in: "header"
+ - name: "paymentId"
+ 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:
- "204":
- description: "Successful operation"
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/Tag"
"400":
- description: "Invalid paymentTransactionExternalKey supplied"
+ description: "Invalid payment id supplied"
+ "404":
+ description: "Invoice not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/{paymentTransactionId}/cancelScheduledPaymentTransaction:
- delete:
+ post:
tags:
- "Payment"
- summary: "Cancels a scheduled payment attempt retry"
+ summary: "Add tags to payment payment"
description: ""
- operationId: "cancelScheduledPaymentTransactionById"
+ operationId: "createPaymentTags"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- - name: "paymentTransactionId"
+ - name: "paymentId"
in: "path"
required: true
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ type: "array"
+ items:
+ type: "string"
+ format: "uuid"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -7444,45 +7464,80 @@ 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 paymentTransactionId supplied"
+ description: "Invalid payment id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments:
- get:
+ delete:
tags:
- "Payment"
- summary: "Retrieve a payment by external key"
+ summary: "Remove tags from payment payment"
description: ""
- operationId: "getPaymentByExternalKey"
+ operationId: "deletePaymentTags"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
- - name: "withPluginInfo"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "withAttempts"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "externalKey"
- in: "query"
+ - name: "paymentId"
+ in: "path"
required: true
type: "string"
- - name: "pluginProperty"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - name: "tagDef"
in: "query"
required: false
type: "array"
items:
type: "string"
+ format: "uuid"
collectionFormat: "multi"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ required: false
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
+ required: false
+ type: "string"
+ responses:
+ "204":
+ description: "Successful operation"
+ "400":
+ description: "Invalid payment id supplied"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ /1.0/kb/payments/{paymentId}/customFields:
+ get:
+ tags:
+ - "Payment"
+ summary: "Retrieve payment custom fields"
+ description: ""
+ operationId: "getPaymentCustomFields"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "paymentId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
- name: "audit"
in: "query"
required: false
@@ -7496,9 +7551,11 @@ paths:
"200":
description: "successful operation"
schema:
- $ref: "#/definitions/Payment"
- "404":
- description: "Payment not found"
+ type: "array"
+ items:
+ $ref: "#/definitions/CustomField"
+ "400":
+ description: "Invalid payment id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -7506,33 +7563,27 @@ paths:
post:
tags:
- "Payment"
- summary: "Capture an existing authorization"
+ summary: "Add custom fields to payment"
description: ""
- operationId: "captureAuthorizationByExternalKey"
+ 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:
- $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
@@ -7547,21 +7598,13 @@ paths:
type: "string"
responses:
"201":
- description: "Payment transaction created successfully"
+ description: "Custom field created successfully"
schema:
- $ref: "#/definitions/Payment"
- "404":
- description: "Account or payment not found"
- "402":
- description: "Transaction declined by gateway"
- "422":
- description: "Payment is aborted by a control plugin"
- "502":
- description: "Failed to submit payment transaction"
- "503":
- description: "Payment in unknown status, failed to receive gateway response"
- "504":
- description: "Payment operation timeout"
+ type: "array"
+ items:
+ $ref: "#/definitions/CustomField"
+ "400":
+ description: "Invalid payment id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -7569,33 +7612,27 @@ paths:
put:
tags:
- "Payment"
- summary: "Complete an existing transaction"
+ summary: "Modify custom fields to payment"
description: ""
- operationId: "completeTransactionByExternalKey"
+ operationId: "modifyPaymentCustomFields"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
+ - name: "paymentId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
- in: "body"
name: "body"
required: true
schema:
- $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
@@ -7611,18 +7648,8 @@ paths:
responses:
"204":
description: "Successful operation"
- "404":
- description: "Account or payment not found"
- "402":
- description: "Transaction declined by gateway"
- "422":
- description: "Payment is aborted by a control plugin"
- "502":
- description: "Failed to submit payment transaction"
- "503":
- description: "Payment in unknown status, failed to receive gateway response"
- "504":
- description: "Payment operation timeout"
+ "400":
+ description: "Invalid payment id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -7630,32 +7657,27 @@ paths:
delete:
tags:
- "Payment"
- summary: "Void an existing payment"
+ summary: "Remove custom fields from payment payment"
description: ""
- operationId: "voidPaymentByExternalKey"
+ operationId: "deletePaymentCustomFields"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- - in: "body"
- name: "body"
+ - name: "paymentId"
+ in: "path"
required: true
- schema:
- $ref: "#/definitions/PaymentTransaction"
- - name: "controlPluginName"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "pluginProperty"
+ 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"
@@ -7672,34 +7694,84 @@ 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: []
- /1.0/kb/payments/chargebacks:
post:
tags:
- "Payment"
- summary: "Record a chargeback"
+ summary: "Capture an existing authorization"
description: ""
- operationId: "chargebackPaymentByExternalKey"
+ operationId: "captureAuthorization"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
+ - name: "paymentId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
- in: "body"
name: "body"
required: true
@@ -7736,6 +7808,8 @@ paths:
description: "Payment transaction created successfully"
schema:
$ref: "#/definitions/Payment"
+ "400":
+ description: "Invalid paymentId supplied"
"404":
description: "Account or payment not found"
"402":
@@ -7752,18 +7826,23 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/chargebackReversals:
- post:
+ put:
tags:
- "Payment"
- summary: "Record a chargeback reversal"
+ summary: "Complete an existing transaction"
description: ""
- operationId: "chargebackReversalPaymentByExternalKey"
+ operationId: "completeTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
+ - name: "paymentId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
- in: "body"
name: "body"
required: true
@@ -7796,10 +7875,10 @@ 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":
description: "Account or payment not found"
"402":
@@ -7816,42 +7895,14 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/attempts/{paymentAttemptId}/auditLogsWithHistory:
- get:
+ delete:
tags:
- "Payment"
- summary: "Retrieve payment attempt audit logs with history by id"
+ summary: "Void an existing payment"
description: ""
- operationId: "getPaymentAttemptAuditLogsWithHistory"
- produces:
+ operationId: "voidPayment"
+ consumes:
- "application/json"
- parameters:
- - name: "paymentAttemptId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
- "404":
- description: "Account not found"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/payments/{paymentId}/auditLogsWithHistory:
- get:
- tags:
- - "Payment"
- summary: "Retrieve payment audit logs with history by id"
- description: ""
- operationId: "getPaymentAuditLogsWithHistory"
produces:
- "application/json"
parameters:
@@ -7861,40 +7912,89 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/PaymentTransaction"
+ - name: "controlPluginName"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ - name: "pluginProperty"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ required: false
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
+ required: false
+ type: "string"
responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
+ "204":
+ description: "Successful operation"
+ "400":
+ description: "Invalid paymentId supplied"
"404":
- description: "Account not found"
+ description: "Account or payment not found"
+ "402":
+ description: "Transaction declined by gateway"
+ "422":
+ description: "Payment is aborted by a control plugin"
+ "502":
+ description: "Failed to submit payment transaction"
+ "503":
+ description: "Payment in unknown status, failed to receive gateway response"
+ "504":
+ description: "Payment operation timeout"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/{paymentId}/tags:
+ /1.0/kb/payments:
get:
tags:
- "Payment"
- summary: "Retrieve payment payment tags"
+ summary: "Retrieve a payment by external key"
description: ""
- operationId: "getPaymentTags"
+ operationId: "getPaymentByExternalKey"
produces:
- "application/json"
parameters:
- - name: "paymentId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "includedDeleted"
+ - name: "withPluginInfo"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "withAttempts"
in: "query"
required: false
type: "boolean"
default: false
+ - name: "externalKey"
+ in: "query"
+ required: true
+ type: "string"
+ - name: "pluginProperty"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
- name: "audit"
in: "query"
required: false
@@ -7908,13 +8008,9 @@ paths:
"200":
description: "successful operation"
schema:
- type: "array"
- items:
- $ref: "#/definitions/Tag"
- "400":
- description: "Invalid payment id supplied"
+ $ref: "#/definitions/Payment"
"404":
- description: "Invoice not found"
+ description: "Payment not found"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -7922,28 +8018,33 @@ paths:
post:
tags:
- "Payment"
- summary: "Add tags to payment payment"
+ summary: "Capture an existing authorization"
description: ""
- operationId: "createPaymentTags"
+ operationId: "captureAuthorizationByExternalKey"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- - name: "paymentId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- in: "body"
name: "body"
required: true
schema:
- type: "array"
- items:
- type: "string"
- format: "uuid"
+ $ref: "#/definitions/PaymentTransaction"
+ - name: "controlPluginName"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ - name: "pluginProperty"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -7958,41 +8059,54 @@ paths:
type: "string"
responses:
"201":
- description: "Tag created successfully"
+ description: "Payment transaction created successfully"
schema:
- type: "array"
- items:
- $ref: "#/definitions/Tag"
- "400":
- description: "Invalid payment id supplied"
+ $ref: "#/definitions/Payment"
+ "404":
+ description: "Account or payment not found"
+ "402":
+ description: "Transaction declined by gateway"
+ "422":
+ description: "Payment is aborted by a control plugin"
+ "502":
+ description: "Failed to submit payment transaction"
+ "503":
+ description: "Payment in unknown status, failed to receive gateway response"
+ "504":
+ description: "Payment operation timeout"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- delete:
+ put:
tags:
- "Payment"
- summary: "Remove tags from payment payment"
+ summary: "Complete an existing transaction"
description: ""
- operationId: "deletePaymentTags"
+ operationId: "completeTransactionByExternalKey"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- - name: "paymentId"
- in: "path"
+ - in: "body"
+ name: "body"
required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "tagDef"
+ schema:
+ $ref: "#/definitions/PaymentTransaction"
+ - name: "controlPluginName"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ - name: "pluginProperty"
in: "query"
required: false
type: "array"
items:
type: "string"
- format: "uuid"
collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
@@ -8009,33 +8123,131 @@ paths:
responses:
"204":
description: "Successful operation"
- "400":
- description: "Invalid payment id supplied"
+ "404":
+ description: "Account or payment not found"
+ "402":
+ description: "Transaction declined by gateway"
+ "422":
+ description: "Payment is aborted by a control plugin"
+ "502":
+ description: "Failed to submit payment transaction"
+ "503":
+ description: "Payment in unknown status, failed to receive gateway response"
+ "504":
+ description: "Payment operation timeout"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/{paymentId}/customFields:
- get:
+ delete:
tags:
- "Payment"
- summary: "Retrieve payment custom fields"
+ summary: "Void an existing payment"
description: ""
- operationId: "getPaymentCustomFields"
+ operationId: "voidPaymentByExternalKey"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
- - name: "paymentId"
- in: "path"
+ - in: "body"
+ name: "body"
required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "audit"
+ schema:
+ $ref: "#/definitions/PaymentTransaction"
+ - name: "controlPluginName"
in: "query"
required: false
- type: "string"
- default: "NONE"
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ - name: "pluginProperty"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ required: false
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
+ required: false
+ type: "string"
+ responses:
+ "204":
+ description: "Successful operation"
+ "404":
+ description: "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/pagination:
+ get:
+ tags:
+ - "Payment"
+ summary: "Get payments"
+ description: ""
+ operationId: "getPayments"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "offset"
+ in: "query"
+ required: false
+ type: "integer"
+ default: 0
+ format: "int64"
+ - name: "limit"
+ in: "query"
+ required: false
+ type: "integer"
+ default: 100
+ format: "int64"
+ - name: "pluginName"
+ in: "query"
+ required: false
+ type: "string"
+ - name: "withPluginInfo"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "withAttempts"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
+ - name: "pluginProperty"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ - name: "audit"
+ in: "query"
+ required: false
+ type: "string"
+ default: "NONE"
enum:
- "FULL"
- "MINIMAL"
@@ -8046,86 +8258,95 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/CustomField"
- "400":
- description: "Invalid payment id supplied"
+ $ref: "#/definitions/Payment"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- post:
+ /1.0/kb/payments/search/{searchKey}:
+ get:
tags:
- "Payment"
- summary: "Add custom fields to payment"
+ summary: "Search payments"
description: ""
- operationId: "createPaymentCustomFields"
- consumes:
- - "application/json"
+ operationId: "searchPayments"
produces:
- "application/json"
parameters:
- - name: "paymentId"
+ - name: "searchKey"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- type: "array"
- items:
- $ref: "#/definitions/CustomField"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
+ 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: "X-Killbill-Comment"
- in: "header"
+ - 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:
- "201":
- description: "Custom field created successfully"
+ "200":
+ description: "successful operation"
schema:
type: "array"
items:
- $ref: "#/definitions/CustomField"
- "400":
- description: "Invalid payment id supplied"
+ $ref: "#/definitions/Payment"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- put:
+ /1.0/kb/payments/cancelScheduledPaymentTransaction:
+ delete:
tags:
- "Payment"
- summary: "Modify custom fields to payment"
+ summary: "Cancels a scheduled payment attempt retry"
description: ""
- operationId: "modifyPaymentCustomFields"
+ operationId: "cancelScheduledPaymentTransactionByExternalKey"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- - name: "paymentId"
- in: "path"
+ - name: "transactionExternalKey"
+ in: "query"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- type: "array"
- items:
- $ref: "#/definitions/CustomField"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -8142,36 +8363,29 @@ paths:
"204":
description: "Successful operation"
"400":
- description: "Invalid payment id supplied"
+ description: "Invalid paymentTransactionExternalKey supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ /1.0/kb/payments/{paymentTransactionId}/cancelScheduledPaymentTransaction:
delete:
tags:
- "Payment"
- summary: "Remove custom fields from payment payment"
+ summary: "Cancels a scheduled payment attempt retry"
description: ""
- operationId: "deletePaymentCustomFields"
+ operationId: "cancelScheduledPaymentTransactionById"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- - name: "paymentId"
+ - name: "paymentTransactionId"
in: "path"
required: true
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "customField"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- format: "uuid"
- collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -8188,18 +8402,20 @@ paths:
"204":
description: "Successful operation"
"400":
- description: "Invalid payment id supplied"
+ description: "Invalid paymentTransactionId supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/{paymentId}:
- get:
+ /1.0/kb/payments/{paymentId}/chargebacks:
+ post:
tags:
- "Payment"
- summary: "Retrieve a payment by id"
+ summary: "Record a chargeback"
description: ""
- operationId: "getPayment"
+ operationId: "chargebackPayment"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
@@ -8209,16 +8425,18 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "withPluginInfo"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "withAttempts"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ $ref: "#/definitions/PaymentTransaction"
+ - name: "controlPluginName"
in: "query"
required: false
- type: "boolean"
- default: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
- name: "pluginProperty"
in: "query"
required: false
@@ -8226,45 +8444,53 @@ 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:
+ "201":
+ description: "Payment transaction created successfully"
+ schema:
$ref: "#/definitions/Payment"
"400":
description: "Invalid paymentId supplied"
"404":
- description: "Payment 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/chargebacks:
post:
tags:
- "Payment"
- summary: "Capture an existing authorization"
+ summary: "Record a chargeback"
description: ""
- operationId: "captureAuthorization"
+ operationId: "chargebackPaymentByExternalKey"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- - name: "paymentId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- in: "body"
name: "body"
required: true
@@ -8301,8 +8527,6 @@ paths:
description: "Payment transaction created successfully"
schema:
$ref: "#/definitions/Payment"
- "400":
- description: "Invalid paymentId supplied"
"404":
description: "Account or payment not found"
"402":
@@ -8319,12 +8543,13 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- put:
+ /1.0/kb/payments/{paymentId}/chargebackReversals:
+ post:
tags:
- "Payment"
- summary: "Complete an existing transaction"
+ summary: "Record a chargeback reversal"
description: ""
- operationId: "completeTransaction"
+ operationId: "chargebackReversalPayment"
consumes:
- "application/json"
produces:
@@ -8368,8 +8593,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":
@@ -8388,23 +8615,18 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- delete:
+ /1.0/kb/payments/chargebackReversals:
+ post:
tags:
- "Payment"
- summary: "Void an existing payment"
+ summary: "Record a chargeback reversal"
description: ""
- operationId: "voidPayment"
+ operationId: "chargebackReversalPaymentByExternalKey"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- - name: "paymentId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- in: "body"
name: "body"
required: true
@@ -8437,10 +8659,10 @@ paths:
required: false
type: "string"
responses:
- "204":
- description: "Successful operation"
- "400":
- description: "Invalid paymentId supplied"
+ "201":
+ description: "Payment transaction created successfully"
+ schema:
+ $ref: "#/definitions/Payment"
"404":
description: "Account or payment not found"
"402":
@@ -8457,144 +8679,129 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/pagination:
- get:
+ /1.0/kb/payments/combo:
+ post:
tags:
- "Payment"
- summary: "Get payments"
+ summary: "Combo api to create a new payment transaction on a existing (or not)\
+ \ account "
description: ""
- operationId: "getPayments"
+ operationId: "createComboPayment"
+ 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/ComboPaymentTransaction"
+ - name: "controlPluginName"
in: "query"
required: false
type: "array"
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"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
+ - name: "X-Killbill-Comment"
+ in: "header"
+ required: false
+ type: "string"
+ responses:
+ "201":
+ description: "Payment transaction created successfully"
+ schema:
+ $ref: "#/definitions/Payment"
+ "400":
+ description: "Invalid data for Account or PaymentMethod"
+ "402":
+ description: "Transaction declined by gateway"
+ "422":
+ description: "Payment is aborted by a control plugin"
+ "502":
+ description: "Failed to submit payment transaction"
+ "503":
+ description: "Payment in unknown status, failed to receive gateway response"
+ "504":
+ description: "Payment operation timeout"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ /1.0/kb/payments/attempts/{paymentAttemptId}/auditLogsWithHistory:
+ get:
+ tags:
+ - "Payment"
+ summary: "Retrieve payment attempt audit logs with history by id"
+ description: ""
+ operationId: "getPaymentAttemptAuditLogsWithHistory"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "paymentAttemptId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
responses:
"200":
description: "successful operation"
schema:
type: "array"
items:
- $ref: "#/definitions/Payment"
+ $ref: "#/definitions/AuditLog"
+ "404":
+ description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/search/{searchKey}:
+ /1.0/kb/payments/{paymentId}/auditLogsWithHistory:
get:
tags:
- "Payment"
- summary: "Search payments"
+ summary: "Retrieve payment audit logs with history by id"
description: ""
- operationId: "searchPayments"
+ operationId: "getPaymentAuditLogsWithHistory"
produces:
- "application/json"
parameters:
- - name: "searchKey"
+ - name: "paymentId"
in: "path"
required: true
type: "string"
- pattern: ".*"
- - name: "offset"
- in: "query"
- required: false
- type: "integer"
- default: 0
- format: "int64"
- - name: "limit"
- in: "query"
- required: false
- type: "integer"
- default: 100
- format: "int64"
- - name: "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"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
responses:
"200":
description: "successful operation"
schema:
type: "array"
items:
- $ref: "#/definitions/Payment"
+ $ref: "#/definitions/AuditLog"
+ "404":
+ description: "Account not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/{paymentId}/chargebacks:
+ /1.0/kb/payments/{paymentId}/refunds:
post:
tags:
- "Payment"
- summary: "Record a chargeback"
+ summary: "Refund an existing payment"
description: ""
- operationId: "chargebackPayment"
+ operationId: "refundPayment"
consumes:
- "application/json"
produces:
@@ -8660,24 +8867,18 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/{paymentId}/chargebackReversals:
+ /1.0/kb/payments/refunds:
post:
tags:
- "Payment"
- summary: "Record a chargeback reversal"
+ summary: "Refund an existing payment"
description: ""
- operationId: "chargebackReversalPayment"
+ operationId: "refundPaymentByExternalKey"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- - name: "paymentId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- in: "body"
name: "body"
required: true
@@ -8714,8 +8915,6 @@ paths:
description: "Payment transaction created successfully"
schema:
$ref: "#/definitions/Payment"
- "400":
- description: "Invalid paymentId supplied"
"404":
description: "Account or payment not found"
"402":
@@ -8732,207 +8931,13 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/payments/combo:
- post:
+ /1.0/kb/pluginsInfo:
+ get:
tags:
- - "Payment"
- summary: "Combo api to create a new payment transaction on a existing (or not)\
- \ account "
+ - "PluginInfo"
+ summary: "Retrieve the list of registered plugins"
description: ""
- operationId: "createComboPayment"
- consumes:
- - "application/json"
- produces:
- - "application/json"
- parameters:
- - in: "body"
- name: "body"
- required: true
- schema:
- $ref: "#/definitions/ComboPaymentTransaction"
- - name: "controlPluginName"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
- responses:
- "201":
- description: "Payment transaction created successfully"
- schema:
- $ref: "#/definitions/Payment"
- "400":
- description: "Invalid data for Account or PaymentMethod"
- "402":
- description: "Transaction declined by gateway"
- "422":
- description: "Payment is aborted by a control plugin"
- "502":
- description: "Failed to submit payment transaction"
- "503":
- description: "Payment in unknown status, failed to receive gateway response"
- "504":
- description: "Payment operation timeout"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/payments/{paymentId}/refunds:
- post:
- tags:
- - "Payment"
- summary: "Refund an existing payment"
- description: ""
- operationId: "refundPayment"
- consumes:
- - "application/json"
- produces:
- - "application/json"
- parameters:
- - name: "paymentId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- $ref: "#/definitions/PaymentTransaction"
- - name: "controlPluginName"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
- responses:
- "201":
- description: "Payment transaction created successfully"
- schema:
- $ref: "#/definitions/Payment"
- "400":
- description: "Invalid paymentId supplied"
- "404":
- description: "Account or payment not found"
- "402":
- description: "Transaction declined by gateway"
- "422":
- description: "Payment is aborted by a control plugin"
- "502":
- description: "Failed to submit payment transaction"
- "503":
- description: "Payment in unknown status, failed to receive gateway response"
- "504":
- description: "Payment operation timeout"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/payments/refunds:
- post:
- tags:
- - "Payment"
- summary: "Refund an existing payment"
- description: ""
- operationId: "refundPaymentByExternalKey"
- consumes:
- - "application/json"
- produces:
- - "application/json"
- parameters:
- - in: "body"
- name: "body"
- required: true
- schema:
- $ref: "#/definitions/PaymentTransaction"
- - name: "controlPluginName"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
- responses:
- "201":
- description: "Payment transaction created successfully"
- schema:
- $ref: "#/definitions/Payment"
- "404":
- description: "Account or payment not found"
- "402":
- description: "Transaction declined by gateway"
- "422":
- description: "Payment is aborted by a control plugin"
- "502":
- description: "Failed to submit payment transaction"
- "503":
- description: "Payment in unknown status, failed to receive gateway response"
- "504":
- description: "Payment operation timeout"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/pluginsInfo:
- get:
- tags:
- - "PluginInfo"
- summary: "Retrieve the list of registered plugins"
- description: ""
- operationId: "getPluginsInfo"
+ operationId: "getPluginsInfo"
produces:
- "application/json"
parameters: []
@@ -9245,14 +9250,14 @@ paths:
$ref: "#/definitions/Subject"
security:
- basicAuth: []
- /1.0/kb/subscriptions/{subscriptionId}/block:
- post:
+ /1.0/kb/subscriptions/{subscriptionId}/tags:
+ get:
tags:
- "Subscription"
- summary: "Block a subscription"
+ summary: "Retrieve subscription tags"
description: ""
- operationId: "addSubscriptionBlockingState"
- consumes:
+ operationId: "getSubscriptionTags"
+ produces:
- "application/json"
parameters:
- name: "subscriptionId"
@@ -9261,42 +9266,27 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- $ref: "#/definitions/BlockingState"
- - name: "requestedDate"
+ - name: "includedDeleted"
in: "query"
required: false
- type: "string"
- format: "date"
- - name: "pluginProperty"
+ type: "boolean"
+ default: false
+ - name: "audit"
in: "query"
required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
responses:
- "201":
- description: "Blocking state created successfully"
+ "200":
+ description: "successful operation"
schema:
type: "array"
items:
- $ref: "#/definitions/BlockingState"
+ $ref: "#/definitions/Tag"
"400":
description: "Invalid subscription id supplied"
"404":
@@ -9305,13 +9295,12 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/subscriptions/{subscriptionId}/customFields:
- get:
+ post:
tags:
- "Subscription"
- summary: "Retrieve subscription custom fields"
- description: ""
- operationId: "getSubscriptionCustomFields"
+ operationId: "createSubscriptionTags"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
@@ -9321,15 +9310,106 @@ 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"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ type: "array"
+ items:
+ type: "string"
+ format: "uuid"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ required: false
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
+ required: false
+ type: "string"
+ responses:
+ "201":
+ description: "Tag created successfully"
+ "400":
+ description: "Invalid subscription id supplied"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ delete:
+ tags:
+ - "Subscription"
+ summary: "Remove tags from subscription"
+ description: ""
+ operationId: "deleteSubscriptionTags"
+ consumes:
+ - "application/json"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "subscriptionId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - name: "tagDef"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ format: "uuid"
+ collectionFormat: "multi"
+ - name: "X-Killbill-CreatedBy"
+ in: "header"
+ required: true
+ type: "string"
+ - name: "X-Killbill-Reason"
+ in: "header"
+ required: false
+ type: "string"
+ - name: "X-Killbill-Comment"
+ in: "header"
+ required: false
+ type: "string"
+ responses:
+ "204":
+ description: "Successful operation"
+ "400":
+ description: "Invalid subscription id supplied"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ /1.0/kb/subscriptions/{subscriptionId}/customFields:
+ get:
+ tags:
+ - "Subscription"
+ summary: "Retrieve subscription custom fields"
+ description: ""
+ operationId: "getSubscriptionCustomFields"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "subscriptionId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - name: "audit"
+ in: "query"
+ required: false
+ type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
responses:
"200":
description: "successful operation"
@@ -9479,61 +9559,32 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/subscriptions/createSubscriptionWithAddOns:
+ /1.0/kb/subscriptions/{subscriptionId}/block:
post:
tags:
- "Subscription"
- summary: "Create an entitlement with addOn products"
+ summary: "Block a subscription"
description: ""
- operationId: "createSubscriptionWithAddOns"
+ operationId: "addSubscriptionBlockingState"
consumes:
- "application/json"
- produces:
- - "application/json"
parameters:
+ - name: "subscriptionId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
- in: "body"
name: "body"
required: true
schema:
- type: "array"
- items:
- $ref: "#/definitions/Subscription"
- - name: "entitlementDate"
- in: "query"
- required: false
- type: "string"
- format: "date"
- - name: "billingDate"
+ $ref: "#/definitions/BlockingState"
+ - name: "requestedDate"
in: "query"
required: false
type: "string"
format: "date"
- - name: "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
@@ -9555,57 +9606,84 @@ paths:
type: "string"
responses:
"201":
- description: "Subscriptions created successfully"
+ description: "Blocking state created successfully"
schema:
- $ref: "#/definitions/Bundle"
+ type: "array"
+ items:
+ $ref: "#/definitions/BlockingState"
+ "400":
+ description: "Invalid subscription id supplied"
+ "404":
+ description: "Subscription not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/subscriptions/createSubscriptionsWithAddOns:
- post:
+ /1.0/kb/subscriptions/{subscriptionId}:
+ get:
tags:
- "Subscription"
- summary: "Create multiple entitlements with addOn products"
+ summary: "Retrieve a subscription by id"
description: ""
- operationId: "createSubscriptionsWithAddOns"
+ operationId: "getSubscription"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "subscriptionId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - name: "audit"
+ in: "query"
+ required: false
+ type: "string"
+ default: "NONE"
+ enum:
+ - "FULL"
+ - "MINIMAL"
+ - "NONE"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ $ref: "#/definitions/Subscription"
+ "400":
+ description: "Invalid subscription id supplied"
+ "404":
+ description: "Subscription not found"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ put:
+ tags:
+ - "Subscription"
+ summary: "Change entitlement plan"
+ description: ""
+ operationId: "changeSubscriptionPlan"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
+ - name: "subscriptionId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
- 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
@@ -9617,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
@@ -9637,81 +9724,22 @@ paths:
required: false
type: "string"
responses:
- "201":
- description: "Subscriptions created successfully"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/Bundle"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/subscriptions/{subscriptionId}/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"
+ "204":
+ description: "Successful operation"
+ "400":
+ description: "Invalid subscription id supplied"
"404":
- description: "Subscription event not found"
+ description: "Entitlement not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/subscriptions/{subscriptionId}/tags:
- get:
+ delete:
tags:
- "Subscription"
- summary: "Retrieve subscription tags"
+ summary: "Cancel an entitlement plan"
description: ""
- operationId: "getSubscriptionTags"
+ operationId: "cancelSubscriptionPlan"
produces:
- "application/json"
parameters:
@@ -9721,103 +9749,49 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "includedDeleted"
+ - name: "requestedDate"
+ in: "query"
+ required: false
+ type: "string"
+ format: "date"
+ - name: "callCompletion"
in: "query"
required: false
type: "boolean"
default: false
- - name: "audit"
+ - name: "callTimeoutSec"
+ in: "query"
+ required: false
+ type: "integer"
+ default: 5
+ format: "int64"
+ - name: "entitlementPolicy"
in: "query"
required: false
type: "string"
- default: "NONE"
enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
- responses:
- "200":
- description: "successful operation"
- schema:
- type: "array"
- items:
- $ref: "#/definitions/Tag"
- "400":
- description: "Invalid subscription id supplied"
- "404":
- description: "Subscription not found"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- post:
- tags:
- - "Subscription"
- operationId: "createSubscriptionTags"
- consumes:
- - "application/json"
- produces:
- - "application/json"
- parameters:
- - name: "subscriptionId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- type: "array"
- items:
- type: "string"
- format: "uuid"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
+ - "IMMEDIATE"
+ - "END_OF_TERM"
+ - name: "billingPolicy"
+ in: "query"
required: false
type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
+ enum:
+ - "START_OF_TERM"
+ - "END_OF_TERM"
+ - "IMMEDIATE"
+ - "ILLEGAL"
+ - name: "useRequestedDateForBilling"
+ in: "query"
required: false
- type: "string"
- responses:
- "201":
- description: "Tag created successfully"
- "400":
- description: "Invalid subscription id supplied"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- delete:
- tags:
- - "Subscription"
- summary: "Remove tags from subscription"
- description: ""
- operationId: "deleteSubscriptionTags"
- consumes:
- - "application/json"
- produces:
- - "application/json"
- parameters:
- - name: "subscriptionId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "tagDef"
+ type: "boolean"
+ default: false
+ - name: "pluginProperty"
in: "query"
required: false
type: "array"
items:
type: "string"
- format: "uuid"
collectionFormat: "multi"
- name: "X-Killbill-CreatedBy"
in: "header"
@@ -9836,26 +9810,26 @@ 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}:
+ /1.0/kb/subscriptions:
get:
tags:
- "Subscription"
- summary: "Retrieve a subscription by id"
+ summary: "Retrieve a subscription by external key"
description: ""
- operationId: "getSubscription"
+ operationId: "getSubscriptionByKey"
produces:
- "application/json"
parameters:
- - name: "subscriptionId"
- in: "path"
+ - name: "externalKey"
+ in: "query"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- name: "audit"
in: "query"
required: false
@@ -9870,41 +9844,53 @@ paths:
description: "successful operation"
schema:
$ref: "#/definitions/Subscription"
- "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: "Create a subscription"
description: ""
- operationId: "changeSubscriptionPlan"
+ operationId: "createSubscription"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- - name: "subscriptionId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- in: "body"
name: "body"
required: true
schema:
$ref: "#/definitions/Subscription"
- - name: "requestedDate"
+ - 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
@@ -9916,15 +9902,6 @@ 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
@@ -9945,68 +9922,69 @@ paths:
required: false
type: "string"
responses:
- "204":
- description: "Successful operation"
- "400":
- description: "Invalid subscription id supplied"
- "404":
- description: "Entitlement not found"
+ "201":
+ 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: "Cancel an entitlement plan"
+ summary: "Create an entitlement with addOn products"
description: ""
- operationId: "cancelSubscriptionPlan"
+ 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: "requestedDate"
+ format: "date"
+ - name: "billingDate"
in: "query"
required: false
type: "string"
format: "date"
- - name: "callCompletion"
+ - name: "migrated"
in: "query"
required: false
type: "boolean"
default: false
- - name: "callTimeoutSec"
- in: "query"
- required: false
- type: "integer"
- default: 5
- format: "int64"
- - name: "entitlementPolicy"
+ - name: "skipResponse"
in: "query"
required: false
- type: "string"
- enum:
- - "IMMEDIATE"
- - "END_OF_TERM"
- - name: "billingPolicy"
+ type: "boolean"
+ default: false
+ - name: "renameKeyIfExistsAndUnused"
in: "query"
required: false
- type: "string"
- enum:
- - "START_OF_TERM"
- - "END_OF_TERM"
- - "IMMEDIATE"
- - "ILLEGAL"
- - name: "useRequestedDateForBilling"
+ 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
@@ -10027,56 +10005,21 @@ paths:
required: false
type: "string"
responses:
- "204":
- description: "Successful operation"
- "400":
- description: "Invalid subscription id supplied"
- "404":
- description: "Entitlement not found"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/subscriptions:
- get:
- tags:
- - "Subscription"
- summary: "Retrieve a subscription by external key"
- description: ""
- operationId: "getSubscriptionByKey"
- produces:
- - "application/json"
- parameters:
- - name: "externalKey"
- in: "query"
- required: true
- type: "string"
- - name: "audit"
- in: "query"
- required: false
- type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
- responses:
- "200":
- description: "successful operation"
+ "201":
+ description: "Subscriptions created successfully"
schema:
- $ref: "#/definitions/Subscription"
- "404":
- description: "Subscription not found"
+ $ref: "#/definitions/Bundle"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ /1.0/kb/subscriptions/createSubscriptionsWithAddOns:
post:
tags:
- "Subscription"
- summary: "Create a subscription"
+ summary: "Create multiple entitlements with addOn products"
description: ""
- operationId: "createSubscription"
+ operationId: "createSubscriptionsWithAddOns"
consumes:
- "application/json"
produces:
@@ -10086,7 +10029,9 @@ paths:
name: "body"
required: true
schema:
- $ref: "#/definitions/Subscription"
+ type: "array"
+ items:
+ $ref: "#/definitions/BulkSubscriptionsBundle"
- name: "entitlementDate"
in: "query"
required: false
@@ -10144,9 +10089,69 @@ paths:
type: "string"
responses:
"201":
- description: "Subscription created successfully"
+ description: "Subscriptions created successfully"
schema:
- $ref: "#/definitions/Subscription"
+ type: "array"
+ items:
+ $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"
security:
- basicAuth: []
- Killbill Api Key: []
@@ -10351,35 +10356,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/{tagDefinitionId}:
get:
tags:
@@ -10521,6 +10497,35 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
+ /1.0/kb/tagDefinitions/{tagDefinitionId}/auditLogsWithHistory:
+ get:
+ tags:
+ - "TagDefinition"
+ summary: "Retrieve tag definition audit logs with history by id"
+ description: ""
+ operationId: "getTagDefinitionAuditLogsWithHistory"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "tagDefinitionId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/AuditLog"
+ "404":
+ description: "Account not found"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
/1.0/kb/tags/pagination:
get:
tags:
@@ -10639,88 +10644,50 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/tenants/uploadPluginPaymentStateMachineConfig/{pluginName}:
+ /1.0/kb/tenants:
get:
tags:
- "Tenant"
- summary: "Retrieve a per tenant payment state machine for a plugin"
+ summary: "Retrieve a tenant by its API key"
description: ""
- operationId: "getPluginPaymentStateMachineConfig"
+ operationId: "getTenantByApiKey"
produces:
- "application/json"
parameters:
- - name: "pluginName"
- in: "path"
- required: true
+ - name: "apiKey"
+ in: "query"
+ required: false
type: "string"
- pattern: ".*"
responses:
"200":
description: "successful operation"
schema:
- $ref: "#/definitions/TenantKeyValue"
- "400":
- description: "Invalid tenantId supplied"
+ $ref: "#/definitions/Tenant"
+ "404":
+ description: "Tenant not found"
security:
- basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
post:
tags:
- "Tenant"
- summary: "Add a per tenant payment state machine for a plugin"
+ summary: "Create a tenant"
description: ""
- operationId: "uploadPluginPaymentStateMachineConfig"
+ operationId: "createTenant"
consumes:
- - "text/plain"
+ - "application/json"
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"
+ $ref: "#/definitions/Tenant"
+ - name: "useGlobalDefault"
+ in: "query"
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: ".*"
+ type: "boolean"
+ default: false
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -10734,24 +10701,29 @@ paths:
required: false
type: "string"
responses:
- "204":
- description: "Successful operation"
- "400":
- description: "Invalid tenantId supplied"
+ "201":
+ description: "Tenant created successfully"
+ schema:
+ $ref: "#/definitions/Tenant"
+ "409":
+ description: "Tenant already exists"
security:
- basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- /1.0/kb/tenants/uploadPerTenantConfig:
+ /1.0/kb/tenants/uploadPluginPaymentStateMachineConfig/{pluginName}:
get:
tags:
- "Tenant"
- summary: "Retrieve a per tenant configuration (system properties)"
+ summary: "Retrieve a per tenant payment state machine for a plugin"
description: ""
- operationId: "getPerTenantConfiguration"
+ operationId: "getPluginPaymentStateMachineConfig"
produces:
- "application/json"
- parameters: []
+ parameters:
+ - name: "pluginName"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: ".*"
responses:
"200":
description: "successful operation"
@@ -10766,14 +10738,19 @@ paths:
post:
tags:
- "Tenant"
- summary: "Add a per tenant configuration (system properties)"
+ summary: "Add a per tenant payment state machine for a plugin"
description: ""
- operationId: "uploadPerTenantConfiguration"
+ operationId: "uploadPluginPaymentStateMachineConfig"
consumes:
- "text/plain"
produces:
- "application/json"
parameters:
+ - name: "pluginName"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: ".*"
- in: "body"
name: "body"
required: true
@@ -10793,7 +10770,7 @@ paths:
type: "string"
responses:
"201":
- description: "Per tenant configuration uploaded successfully"
+ description: "Per tenant state machine uploaded successfully"
schema:
$ref: "#/definitions/TenantKeyValue"
"400":
@@ -10805,10 +10782,15 @@ paths:
delete:
tags:
- "Tenant"
- summary: "Delete a per tenant configuration (system properties)"
+ summary: "Delete a per tenant payment state machine for a plugin"
description: ""
- operationId: "deletePerTenantConfiguration"
+ operationId: "deletePluginPaymentStateMachineConfig"
parameters:
+ - name: "pluginName"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: ".*"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -10830,13 +10812,13 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/tenants/registerNotificationCallback:
+ /1.0/kb/tenants/uploadPerTenantConfig:
get:
tags:
- "Tenant"
- summary: "Retrieve a push notification"
+ summary: "Retrieve a per tenant configuration (system properties)"
description: ""
- operationId: "getPushNotificationCallbacks"
+ operationId: "getPerTenantConfiguration"
produces:
- "application/json"
parameters: []
@@ -10854,18 +10836,19 @@ paths:
post:
tags:
- "Tenant"
- summary: "Create a push notification"
+ summary: "Add a per tenant configuration (system properties)"
description: ""
- operationId: "registerPushNotificationCallback"
+ operationId: "uploadPerTenantConfiguration"
consumes:
- - "application/json"
+ - "text/plain"
produces:
- "application/json"
parameters:
- - name: "cb"
- in: "query"
- required: false
- type: "string"
+ - in: "body"
+ name: "body"
+ required: true
+ schema:
+ type: "string"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -10880,7 +10863,7 @@ paths:
type: "string"
responses:
"201":
- description: "Push notification registered successfully"
+ description: "Per tenant configuration uploaded successfully"
schema:
$ref: "#/definitions/TenantKeyValue"
"400":
@@ -10892,9 +10875,9 @@ paths:
delete:
tags:
- "Tenant"
- summary: "Delete a push notification"
+ summary: "Delete a per tenant configuration (system properties)"
description: ""
- operationId: "deletePushNotificationCallbacks"
+ operationId: "deletePerTenantConfiguration"
parameters:
- name: "X-Killbill-CreatedBy"
in: "header"
@@ -10917,50 +10900,53 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/tenants:
+ /1.0/kb/tenants/uploadPluginConfig/{pluginName}:
get:
tags:
- "Tenant"
- summary: "Retrieve a tenant by its API key"
+ summary: "Retrieve a per tenant configuration for a plugin"
description: ""
- operationId: "getTenantByApiKey"
+ operationId: "getPluginConfiguration"
produces:
- "application/json"
parameters:
- - name: "apiKey"
- in: "query"
- required: false
+ - name: "pluginName"
+ in: "path"
+ required: true
type: "string"
+ pattern: ".*"
responses:
"200":
description: "successful operation"
schema:
- $ref: "#/definitions/Tenant"
- "404":
- description: "Tenant not found"
+ $ref: "#/definitions/TenantKeyValue"
+ "400":
+ description: "Invalid tenantId supplied"
security:
- basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
post:
tags:
- "Tenant"
- summary: "Create a tenant"
+ summary: "Add a per tenant configuration for a plugin"
description: ""
- operationId: "createTenant"
+ operationId: "uploadPluginConfiguration"
consumes:
- - "application/json"
+ - "text/plain"
produces:
- "application/json"
parameters:
+ - name: "pluginName"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: ".*"
- in: "body"
name: "body"
required: true
schema:
- $ref: "#/definitions/Tenant"
- - name: "useGlobalDefault"
- in: "query"
- required: false
- type: "boolean"
- default: false
+ type: "string"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -10975,57 +10961,58 @@ paths:
type: "string"
responses:
"201":
- description: "Tenant created successfully"
+ description: "Plugin configuration uploaded successfully"
schema:
- $ref: "#/definitions/Tenant"
- "409":
- description: "Tenant already exists"
+ $ref: "#/definitions/TenantKeyValue"
+ "400":
+ description: "Invalid tenantId supplied"
security:
- basicAuth: []
- /1.0/kb/tenants/{tenantId}:
- get:
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ delete:
tags:
- "Tenant"
- summary: "Retrieve a tenant by id"
+ summary: "Delete a per tenant configuration for a plugin"
description: ""
- operationId: "getTenant"
- produces:
- - "application/json"
+ operationId: "deletePluginConfiguration"
parameters:
- - name: "tenantId"
+ - name: "pluginName"
in: "path"
required: true
type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
+ 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:
- "200":
- description: "successful operation"
- schema:
- $ref: "#/definitions/Tenant"
+ "204":
+ description: "Successful operation"
"400":
description: "Invalid tenantId supplied"
- "404":
- description: "Tenant not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/tenants/uploadPluginConfig/{pluginName}:
+ /1.0/kb/tenants/registerNotificationCallback:
get:
tags:
- "Tenant"
- summary: "Retrieve a per tenant configuration for a plugin"
+ summary: "Retrieve a push notification"
description: ""
- operationId: "getPluginConfiguration"
+ operationId: "getPushNotificationCallbacks"
produces:
- "application/json"
- parameters:
- - name: "pluginName"
- in: "path"
- required: true
- type: "string"
- pattern: ".*"
+ parameters: []
responses:
"200":
description: "successful operation"
@@ -11040,24 +11027,18 @@ paths:
post:
tags:
- "Tenant"
- summary: "Add a per tenant configuration for a plugin"
+ summary: "Create a push notification"
description: ""
- operationId: "uploadPluginConfiguration"
+ operationId: "registerPushNotificationCallback"
consumes:
- - "text/plain"
+ - "application/json"
produces:
- "application/json"
parameters:
- - name: "pluginName"
- in: "path"
- required: true
+ - name: "cb"
+ in: "query"
+ required: false
type: "string"
- pattern: ".*"
- - in: "body"
- name: "body"
- required: true
- schema:
- type: "string"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -11072,7 +11053,7 @@ paths:
type: "string"
responses:
"201":
- description: "Plugin configuration uploaded successfully"
+ description: "Push notification registered successfully"
schema:
$ref: "#/definitions/TenantKeyValue"
"400":
@@ -11084,15 +11065,10 @@ paths:
delete:
tags:
- "Tenant"
- summary: "Delete a per tenant configuration for a plugin"
+ summary: "Delete a push notification"
description: ""
- operationId: "deletePluginConfiguration"
+ operationId: "deletePushNotificationCallbacks"
parameters:
- - name: "pluginName"
- in: "path"
- required: true
- type: "string"
- pattern: ".*"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -11245,64 +11221,42 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/paymentTransactions:
+ /1.0/kb/tenants/{tenantId}:
get:
tags:
- - "PaymentTransaction"
- summary: "Retrieve a payment by transaction external key"
+ - "Tenant"
+ summary: "Retrieve a tenant by id"
description: ""
- operationId: "getPaymentByTransactionExternalKey"
+ operationId: "getTenant"
produces:
- "application/json"
parameters:
- - name: "transactionExternalKey"
- in: "query"
+ - name: "tenantId"
+ in: "path"
required: true
type: "string"
- - name: "withPluginInfo"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "withAttempts"
- in: "query"
- required: false
- type: "boolean"
- default: false
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
- items:
- type: "string"
- collectionFormat: "multi"
- - name: "audit"
- in: "query"
- required: false
- type: "string"
- default: "NONE"
- enum:
- - "FULL"
- - "MINIMAL"
- - "NONE"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
responses:
"200":
description: "successful operation"
schema:
- $ref: "#/definitions/Payment"
+ $ref: "#/definitions/Tenant"
+ "400":
+ description: "Invalid tenantId supplied"
"404":
- description: "Payment not found"
+ description: "Tenant not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/paymentTransactions/{transactionId}/customFields:
+ /1.0/kb/paymentTransactions/{transactionId}/tags:
get:
tags:
- "PaymentTransaction"
- summary: "Retrieve payment transaction custom fields"
+ summary: "Retrieve payment transaction tags"
description: ""
- operationId: "getTransactionCustomFields"
+ operationId: "getTransactionTags"
produces:
- "application/json"
parameters:
@@ -11312,6 +11266,11 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
+ - name: "includedDeleted"
+ in: "query"
+ required: false
+ type: "boolean"
+ default: false
- name: "audit"
in: "query"
required: false
@@ -11327,9 +11286,11 @@ paths:
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: []
@@ -11337,9 +11298,9 @@ paths:
post:
tags:
- "PaymentTransaction"
- summary: "Add custom fields to payment transaction"
+ summary: "Add tags to payment transaction"
description: ""
- operationId: "createTransactionCustomFields"
+ operationId: "createTransactionTags"
consumes:
- "application/json"
produces:
@@ -11357,7 +11318,8 @@ paths:
schema:
type: "array"
items:
- $ref: "#/definitions/CustomField"
+ type: "string"
+ format: "uuid"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -11372,56 +11334,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 transaction id supplied"
- security:
- - basicAuth: []
- - Killbill Api Key: []
- - Killbill Api Secret: []
- put:
- tags:
- - "PaymentTransaction"
- summary: "Modify custom fields to payment transaction"
- description: ""
- operationId: "modifyTransactionCustomFields"
- consumes:
- - "application/json"
- produces:
- - "application/json"
- parameters:
- - name: "transactionId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - in: "body"
- name: "body"
- required: true
- schema:
- type: "array"
- items:
- $ref: "#/definitions/CustomField"
- - name: "X-Killbill-CreatedBy"
- in: "header"
- required: true
- type: "string"
- - name: "X-Killbill-Reason"
- in: "header"
- required: false
- type: "string"
- - name: "X-Killbill-Comment"
- in: "header"
- required: false
- type: "string"
- responses:
- "204":
- description: "Successful operation"
+ $ref: "#/definitions/Tag"
"400":
description: "Invalid transaction id supplied"
security:
@@ -11431,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:
@@ -11445,7 +11362,7 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "customField"
+ - name: "tagDef"
in: "query"
required: false
type: "array"
@@ -11474,13 +11391,13 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/paymentTransactions/{transactionId}/auditLogsWithHistory:
+ /1.0/kb/paymentTransactions/{transactionId}/customFields:
get:
tags:
- "PaymentTransaction"
- summary: "Retrieve payment transaction audit logs with history by id"
+ summary: "Retrieve payment transaction custom fields"
description: ""
- operationId: "getTransactionAuditLogsWithHistory"
+ operationId: "getTransactionCustomFields"
produces:
- "application/json"
parameters:
@@ -11490,26 +11407,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: "Account not found"
+ $ref: "#/definitions/CustomField"
+ "400":
+ description: "Invalid transaction id supplied"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/paymentTransactions/{transactionId}/tags:
- get:
+ post:
tags:
- "PaymentTransaction"
- summary: "Retrieve payment transaction tags"
+ summary: "Add custom fields to payment transaction"
description: ""
- operationId: "getTransactionTags"
+ operationId: "createTransactionCustomFields"
+ consumes:
+ - "application/json"
produces:
- "application/json"
parameters:
@@ -11519,41 +11446,44 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "includedDeleted"
- 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"
+ "201":
+ description: "Custom field created successfully"
schema:
type: "array"
items:
- $ref: "#/definitions/Tag"
+ $ref: "#/definitions/CustomField"
"400":
description: "Invalid transaction id supplied"
- "404":
- description: "Invoice not found"
security:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- post:
+ put:
tags:
- "PaymentTransaction"
- summary: "Add tags to payment transaction"
+ summary: "Modify custom fields to payment transaction"
description: ""
- operationId: "createTransactionTags"
+ operationId: "modifyTransactionCustomFields"
consumes:
- "application/json"
produces:
@@ -11571,8 +11501,7 @@ paths:
schema:
type: "array"
items:
- type: "string"
- format: "uuid"
+ $ref: "#/definitions/CustomField"
- name: "X-Killbill-CreatedBy"
in: "header"
required: true
@@ -11586,12 +11515,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 transaction id supplied"
security:
@@ -11601,9 +11526,9 @@ paths:
delete:
tags:
- "PaymentTransaction"
- summary: "Remove tags from payment transaction"
+ summary: "Remove custom fields from payment transaction"
description: ""
- operationId: "deleteTransactionTags"
+ operationId: "deleteTransactionCustomFields"
consumes:
- "application/json"
produces:
@@ -11615,7 +11540,7 @@ paths:
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "tagDef"
+ - name: "customField"
in: "query"
required: false
type: "array"
@@ -11751,36 +11676,30 @@ paths:
- basicAuth: []
- Killbill Api Key: []
- Killbill Api Secret: []
- /1.0/kb/usages/{subscriptionId}/{unitType}:
+ /1.0/kb/paymentTransactions:
get:
tags:
- - "Usage"
- summary: "Retrieve usage for a subscription and unit type"
+ - "PaymentTransaction"
+ summary: "Retrieve a payment by transaction external key"
description: ""
- operationId: "getUsage"
+ operationId: "getPaymentByTransactionExternalKey"
produces:
- "application/json"
parameters:
- - name: "subscriptionId"
- in: "path"
- required: true
- type: "string"
- pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
- format: "uuid"
- - name: "unitType"
- in: "path"
+ - name: "transactionExternalKey"
+ in: "query"
required: true
type: "string"
- - name: "startDate"
+ - name: "withPluginInfo"
in: "query"
required: false
- type: "string"
- format: "date"
- - name: "endDate"
+ type: "boolean"
+ default: false
+ - name: "withAttempts"
in: "query"
required: false
- type: "string"
- format: "date"
+ type: "boolean"
+ default: false
- name: "pluginProperty"
in: "query"
required: false
@@ -11788,47 +11707,133 @@ 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/{subscriptionId}:
+ /1.0/kb/paymentTransactions/{transactionId}/auditLogsWithHistory:
get:
tags:
- - "Usage"
- summary: "Retrieve usage for a subscription"
+ - "PaymentTransaction"
+ summary: "Retrieve payment transaction audit logs with history by id"
description: ""
- operationId: "getAllUsage"
+ operationId: "getTransactionAuditLogsWithHistory"
produces:
- "application/json"
parameters:
- - name: "subscriptionId"
+ - name: "transactionId"
in: "path"
required: true
type: "string"
pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
format: "uuid"
- - name: "startDate"
- in: "query"
- required: false
- type: "string"
- format: "date"
- - name: "endDate"
- in: "query"
- required: false
- type: "string"
- format: "date"
- - name: "pluginProperty"
- in: "query"
- required: false
- type: "array"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/AuditLog"
+ "404":
+ description: "Account not found"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ /1.0/kb/usages/{subscriptionId}/{unitType}:
+ get:
+ tags:
+ - "Usage"
+ summary: "Retrieve usage for a subscription and unit type"
+ description: ""
+ operationId: "getUsage"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "subscriptionId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - name: "unitType"
+ in: "path"
+ required: true
+ type: "string"
+ - name: "startDate"
+ in: "query"
+ required: false
+ type: "string"
+ format: "date"
+ - name: "endDate"
+ in: "query"
+ required: false
+ type: "string"
+ format: "date"
+ - name: "pluginProperty"
+ in: "query"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "multi"
+ responses:
+ "200":
+ description: "successful operation"
+ schema:
+ $ref: "#/definitions/RolledUpUsage"
+ "400":
+ description: "Missing start date or end date"
+ security:
+ - basicAuth: []
+ - Killbill Api Key: []
+ - Killbill Api Secret: []
+ /1.0/kb/usages/{subscriptionId}:
+ get:
+ tags:
+ - "Usage"
+ summary: "Retrieve usage for a subscription"
+ description: ""
+ operationId: "getAllUsage"
+ produces:
+ - "application/json"
+ parameters:
+ - name: "subscriptionId"
+ in: "path"
+ required: true
+ type: "string"
+ pattern: "\\w+-\\w+-\\w+-\\w+-\\w+"
+ format: "uuid"
+ - name: "startDate"
+ in: "query"
+ required: false
+ type: "string"
+ format: "date"
+ - name: "endDate"
+ in: "query"
+ required: false
+ type: "string"
+ format: "date"
+ - name: "pluginProperty"
+ in: "query"
+ required: false
+ type: "array"
items:
type: "string"
collectionFormat: "multi"
@@ -11939,20 +11944,144 @@ definitions:
Entity:
type: "object"
properties:
- id:
- type: "string"
- format: "uuid"
createdDate:
type: "string"
format: "date-time"
updatedDate:
type: "string"
format: "date-time"
- Invoice:
+ id:
+ type: "string"
+ format: "uuid"
+ Tag:
type: "object"
properties:
- amount:
- type: "number"
+ 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:
@@ -12121,125 +12250,88 @@ definitions:
- "ZMW"
- "ZWD"
- "BTC"
- status:
+ parentAccountId:
type: "string"
- enum:
- - "DRAFT"
- - "COMMITTED"
- - "VOID"
- creditAdj:
- type: "number"
- refundAdj:
- type: "number"
- invoiceId:
+ format: "uuid"
+ isPaymentDelegatedToParent:
+ type: "boolean"
+ paymentMethodId:
type: "string"
format: "uuid"
- invoiceDate:
+ referenceTime:
type: "string"
- format: "date"
- targetDate:
+ format: "date-time"
+ timeZone:
type: "string"
- format: "date"
- invoiceNumber:
+ address1:
type: "string"
- balance:
- type: "number"
- accountId:
+ address2:
type: "string"
- format: "uuid"
- bundleKeys:
+ postalCode:
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:
+ company:
type: "string"
- format: "uuid"
- parentAccountId:
+ city:
type: "string"
- format: "uuid"
+ 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"
- InvoiceItem:
+ AccountEmail:
type: "object"
required:
- - "accountId"
- - "invoiceItemId"
+ - "email"
properties:
- invoiceItemId:
+ accountId:
type: "string"
format: "uuid"
- invoiceId:
+ email:
type: "string"
- format: "uuid"
- linkedInvoiceItemId:
+ auditLogs:
+ type: "array"
+ items:
+ $ref: "#/definitions/AuditLog"
+ InvoicePayment:
+ type: "object"
+ properties:
+ targetInvoiceId:
type: "string"
format: "uuid"
accountId:
type: "string"
format: "uuid"
- childAccountId:
- type: "string"
- format: "uuid"
- bundleId:
- type: "string"
- format: "uuid"
- subscriptionId:
+ paymentId:
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:
+ paymentNumber:
type: "string"
- format: "date"
- endDate:
+ paymentExternalKey:
type: "string"
- format: "date"
- amount:
+ authAmount:
type: "number"
- rate:
+ capturedAmount:
+ type: "number"
+ purchasedAmount:
+ type: "number"
+ refundedAmount:
+ type: "number"
+ creditedAmount:
type: "number"
currency:
type: "string"
@@ -12409,87 +12501,58 @@ definitions:
- "ZMW"
- "ZWD"
- "BTC"
- quantity:
- type: "number"
- itemDetails:
- type: "string"
- catalogEffectiveDate:
+ paymentMethodId:
type: "string"
- format: "date-time"
- childItems:
+ format: "uuid"
+ transactions:
type: "array"
items:
- $ref: "#/definitions/InvoiceItem"
- auditLogs:
+ $ref: "#/definitions/PaymentTransaction"
+ paymentAttempts:
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"
+ $ref: "#/definitions/PaymentAttempt"
auditLogs:
type: "array"
items:
$ref: "#/definitions/AuditLog"
- PaymentMethodPluginDetail:
+ PaymentAttempt:
type: "object"
properties:
- externalPaymentMethodId:
+ accountId:
type: "string"
- isDefaultPaymentMethod:
- type: "boolean"
- properties:
- type: "array"
- items:
- $ref: "#/definitions/PluginProperty"
- PluginProperty:
- type: "object"
- properties:
- key:
+ format: "uuid"
+ paymentMethodId:
type: "string"
- value:
+ format: "uuid"
+ paymentExternalKey:
type: "string"
- isUpdatable:
- type: "boolean"
- Payment:
- type: "object"
- properties:
- accountId:
+ transactionId:
type: "string"
format: "uuid"
- paymentId:
+ transactionExternalKey:
type: "string"
- format: "uuid"
- paymentNumber:
+ transactionType:
type: "string"
- paymentExternalKey:
+ enum:
+ - "AUTHORIZE"
+ - "CAPTURE"
+ - "CHARGEBACK"
+ - "CREDIT"
+ - "PURCHASE"
+ - "REFUND"
+ - "VOID"
+ effectiveDate:
type: "string"
- authAmount:
- type: "number"
- capturedAmount:
- type: "number"
- purchasedAmount:
- type: "number"
- refundedAmount:
- type: "number"
- creditedAmount:
+ format: "date-time"
+ stateName:
+ type: "string"
+ amount:
type: "number"
+ description: "Transaction amount, required except for void operations"
currency:
type: "string"
+ description: "Amount currency (account currency unless specified)"
enum:
- "AED"
- "AFN"
@@ -12656,36 +12719,29 @@ definitions:
- "ZMW"
- "ZWD"
- "BTC"
- paymentMethodId:
+ pluginName:
type: "string"
- format: "uuid"
- transactions:
- type: "array"
- items:
- $ref: "#/definitions/PaymentTransaction"
- paymentAttempts:
+ pluginProperties:
type: "array"
items:
- $ref: "#/definitions/PaymentAttempt"
+ $ref: "#/definitions/PluginProperty"
auditLogs:
type: "array"
items:
$ref: "#/definitions/AuditLog"
- PaymentAttempt:
+ PaymentTransaction:
type: "object"
properties:
- accountId:
- type: "string"
- format: "uuid"
- paymentMethodId:
+ transactionId:
type: "string"
format: "uuid"
- paymentExternalKey:
+ transactionExternalKey:
type: "string"
- transactionId:
+ paymentId:
type: "string"
format: "uuid"
- transactionExternalKey:
+ description: "Associated payment id, required when notifying state transitions"
+ paymentExternalKey:
type: "string"
transactionType:
type: "string"
@@ -12697,11 +12753,6 @@ definitions:
- "PURCHASE"
- "REFUND"
- "VOID"
- effectiveDate:
- type: "string"
- format: "date-time"
- stateName:
- type: "string"
amount:
type: "number"
description: "Transaction amount, required except for void operations"
@@ -12874,218 +12925,12 @@ definitions:
- "ZMW"
- "ZWD"
- "BTC"
- pluginName:
- type: "string"
- pluginProperties:
- type: "array"
- items:
- $ref: "#/definitions/PluginProperty"
- auditLogs:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
- PaymentTransaction:
- type: "object"
- properties:
- transactionId:
- type: "string"
- format: "uuid"
- transactionExternalKey:
+ effectiveDate:
type: "string"
- paymentId:
- type: "string"
- format: "uuid"
- description: "Associated payment id, required when notifying state transitions"
- paymentExternalKey:
- type: "string"
- transactionType:
- type: "string"
- enum:
- - "AUTHORIZE"
- - "CAPTURE"
- - "CHARGEBACK"
- - "CREDIT"
- - "PURCHASE"
- - "REFUND"
- - "VOID"
- amount:
- type: "number"
- description: "Transaction amount, required except for void operations"
- currency:
- type: "string"
- description: "Amount currency (account currency unless specified)"
- enum:
- - "AED"
- - "AFN"
- - "ALL"
- - "AMD"
- - "ANG"
- - "AOA"
- - "ARS"
- - "AUD"
- - "AWG"
- - "AZN"
- - "BAM"
- - "BBD"
- - "BDT"
- - "BGN"
- - "BHD"
- - "BIF"
- - "BMD"
- - "BND"
- - "BOB"
- - "BRL"
- - "BSD"
- - "BTN"
- - "BWP"
- - "BYR"
- - "BZD"
- - "CAD"
- - "CDF"
- - "CHF"
- - "CLP"
- - "CNY"
- - "COP"
- - "CRC"
- - "CUC"
- - "CUP"
- - "CVE"
- - "CZK"
- - "DJF"
- - "DKK"
- - "DOP"
- - "DZD"
- - "EGP"
- - "ERN"
- - "ETB"
- - "EUR"
- - "FJD"
- - "FKP"
- - "GBP"
- - "GEL"
- - "GGP"
- - "GHS"
- - "GIP"
- - "GMD"
- - "GNF"
- - "GTQ"
- - "GYD"
- - "HKD"
- - "HNL"
- - "HRK"
- - "HTG"
- - "HUF"
- - "IDR"
- - "ILS"
- - "IMP"
- - "INR"
- - "IQD"
- - "IRR"
- - "ISK"
- - "JEP"
- - "JMD"
- - "JOD"
- - "JPY"
- - "KES"
- - "KGS"
- - "KHR"
- - "KMF"
- - "KPW"
- - "KRW"
- - "KWD"
- - "KYD"
- - "KZT"
- - "LAK"
- - "LBP"
- - "LKR"
- - "LRD"
- - "LSL"
- - "LTL"
- - "LVL"
- - "LYD"
- - "MAD"
- - "MDL"
- - "MGA"
- - "MKD"
- - "MMK"
- - "MNT"
- - "MOP"
- - "MRO"
- - "MUR"
- - "MVR"
- - "MWK"
- - "MXN"
- - "MYR"
- - "MZN"
- - "NAD"
- - "NGN"
- - "NIO"
- - "NOK"
- - "NPR"
- - "NZD"
- - "OMR"
- - "PAB"
- - "PEN"
- - "PGK"
- - "PHP"
- - "PKR"
- - "PLN"
- - "PYG"
- - "QAR"
- - "RON"
- - "RSD"
- - "RUB"
- - "RWF"
- - "SAR"
- - "SBD"
- - "SCR"
- - "SDG"
- - "SEK"
- - "SGD"
- - "SHP"
- - "SLL"
- - "SOS"
- - "SPL"
- - "SRD"
- - "STD"
- - "SVC"
- - "SYP"
- - "SZL"
- - "THB"
- - "TJS"
- - "TMT"
- - "TND"
- - "TOP"
- - "TRY"
- - "TTD"
- - "TVD"
- - "TWD"
- - "TZS"
- - "UAH"
- - "UGX"
- - "USD"
- - "UYU"
- - "UZS"
- - "VEF"
- - "VND"
- - "VUV"
- - "WST"
- - "XAF"
- - "XCD"
- - "XDR"
- - "XOF"
- - "XPF"
- - "YER"
- - "ZAR"
- - "ZMW"
- - "ZWD"
- - "BTC"
- effectiveDate:
- type: "string"
- format: "date-time"
- processedAmount:
- type: "number"
- processedCurrency:
+ format: "date-time"
+ processedAmount:
+ type: "number"
+ processedCurrency:
type: "string"
enum:
- "AED"
@@ -13279,172 +13124,370 @@ definitions:
type: "array"
items:
$ref: "#/definitions/AuditLog"
- Tag:
+ PluginProperty:
type: "object"
properties:
- tagId:
+ key:
type: "string"
- format: "uuid"
- objectType:
+ value:
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:
+ isUpdatable:
+ type: "boolean"
+ PaymentMethod:
+ type: "object"
+ properties:
+ paymentMethodId:
type: "string"
format: "uuid"
- tagDefinitionId:
+ externalKey:
+ type: "string"
+ accountId:
type: "string"
format: "uuid"
- tagDefinitionName:
+ isDefault:
+ type: "boolean"
+ pluginName:
type: "string"
+ pluginInfo:
+ $ref: "#/definitions/PaymentMethodPluginDetail"
auditLogs:
type: "array"
items:
$ref: "#/definitions/AuditLog"
- CustomField:
+ PaymentMethodPluginDetail:
type: "object"
- required:
- - "name"
- - "value"
properties:
- customFieldId:
+ externalPaymentMethodId:
type: "string"
- format: "uuid"
- objectId:
+ isDefaultPaymentMethod:
+ type: "boolean"
+ properties:
+ type: "array"
+ items:
+ $ref: "#/definitions/PluginProperty"
+ BlockPrice:
+ type: "object"
+ properties:
+ unitName:
type: "string"
- format: "uuid"
- objectType:
+ size:
+ type: "number"
+ price:
+ type: "number"
+ max:
+ type: "number"
+ Bundle:
+ type: "object"
+ required:
+ - "accountId"
+ properties:
+ accountId:
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:
+ format: "uuid"
+ bundleId:
type: "string"
- value:
+ format: "uuid"
+ externalKey:
type: "string"
+ subscriptions:
+ type: "array"
+ items:
+ $ref: "#/definitions/Subscription"
+ timeline:
+ $ref: "#/definitions/BundleTimeline"
auditLogs:
type: "array"
items:
$ref: "#/definitions/AuditLog"
- BlockingState:
+ BundleTimeline:
type: "object"
properties:
- blockedId:
+ accountId:
type: "string"
format: "uuid"
- stateName:
+ bundleId:
type: "string"
- service:
+ format: "uuid"
+ externalKey:
type: "string"
- isBlockChange:
- type: "boolean"
- isBlockEntitlement:
- type: "boolean"
- isBlockBilling:
- type: "boolean"
+ 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"
- type:
+ catalogEffectiveDate:
+ type: "string"
+ format: "date-time"
+ plan:
+ type: "string"
+ product:
+ type: "string"
+ priceList:
+ type: "string"
+ eventType:
type: "string"
enum:
- - "SUBSCRIPTION"
- - "SUBSCRIPTION_BUNDLE"
- - "ACCOUNT"
+ - "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"
- AccountEmail:
+ PhasePrice:
type: "object"
- required:
- - "email"
properties:
- accountId:
+ planName:
type: "string"
- format: "uuid"
- email:
+ phaseName:
type: "string"
- auditLogs:
+ phaseType:
+ type: "string"
+ fixedPrice:
+ type: "number"
+ recurringPrice:
+ type: "number"
+ usagePrices:
type: "array"
items:
- $ref: "#/definitions/AuditLog"
- Account:
+ $ref: "#/definitions/UsagePrice"
+ Subscription:
type: "object"
+ required:
+ - "billingPeriod"
+ - "planName"
+ - "priceList"
+ - "productName"
properties:
accountId:
type: "string"
format: "uuid"
- name:
+ bundleId:
type: "string"
- firstNameLength:
- type: "integer"
- format: "int32"
+ format: "uuid"
+ bundleExternalKey:
+ type: "string"
+ subscriptionId:
+ type: "string"
+ format: "uuid"
externalKey:
type: "string"
- email:
+ startDate:
+ type: "string"
+ format: "date-time"
+ productName:
+ type: "string"
+ productCategory:
+ type: "string"
+ enum:
+ - "BASE"
+ - "ADD_ON"
+ - "STANDALONE"
+ billingPeriod:
+ type: "string"
+ enum:
+ - "DAILY"
+ - "WEEKLY"
+ - "BIWEEKLY"
+ - "THIRTY_DAYS"
+ - "THIRTY_ONE_DAYS"
+ - "SIXTY_DAYS"
+ - "NINETY_DAYS"
+ - "MONTHLY"
+ - "BIMESTRIAL"
+ - "QUARTERLY"
+ - "TRIANNUAL"
+ - "BIANNUAL"
+ - "ANNUAL"
+ - "SESQUIENNIAL"
+ - "BIENNIAL"
+ - "TRIENNIAL"
+ - "NO_BILLING_PERIOD"
+ phaseType:
+ type: "string"
+ enum:
+ - "TRIAL"
+ - "DISCOUNT"
+ - "FIXEDTERM"
+ - "EVERGREEN"
+ priceList:
+ type: "string"
+ planName:
+ type: "string"
+ state:
+ type: "string"
+ enum:
+ - "PENDING"
+ - "ACTIVE"
+ - "BLOCKED"
+ - "CANCELLED"
+ - "EXPIRED"
+ sourceType:
+ type: "string"
+ enum:
+ - "NATIVE"
+ - "MIGRATED"
+ - "TRANSFERRED"
+ cancelledDate:
+ type: "string"
+ format: "date-time"
+ chargedThroughDate:
+ type: "string"
+ format: "date"
+ billingStartDate:
+ type: "string"
+ format: "date-time"
+ billingEndDate:
type: "string"
+ format: "date-time"
billCycleDayLocal:
type: "integer"
format: "int32"
- currency:
- type: "string"
- enum:
- - "AED"
- - "AFN"
- - "ALL"
- - "AMD"
- - "ANG"
- - "AOA"
- - "ARS"
- - "AUD"
- - "AWG"
- - "AZN"
- - "BAM"
- - "BBD"
- - "BDT"
- - "BGN"
- - "BHD"
- - "BIF"
- - "BMD"
- - "BND"
- - "BOB"
- - "BRL"
+ quantity:
+ type: "integer"
+ format: "int32"
+ events:
+ type: "array"
+ items:
+ $ref: "#/definitions/EventSubscription"
+ priceOverrides:
+ type: "array"
+ items:
+ $ref: "#/definitions/PhasePrice"
+ prices:
+ type: "array"
+ items:
+ $ref: "#/definitions/PhasePrice"
+ auditLogs:
+ type: "array"
+ items:
+ $ref: "#/definitions/AuditLog"
+ TierPrice:
+ type: "object"
+ properties:
+ blockPrices:
+ type: "array"
+ items:
+ $ref: "#/definitions/BlockPrice"
+ UsagePrice:
+ type: "object"
+ properties:
+ usageName:
+ type: "string"
+ usageType:
+ type: "string"
+ enum:
+ - "CAPACITY"
+ - "CONSUMABLE"
+ billingMode:
+ type: "string"
+ enum:
+ - "IN_ADVANCE"
+ - "IN_ARREAR"
+ tierBlockPolicy:
+ type: "string"
+ enum:
+ - "ALL_TIERS"
+ - "TOP_TIER"
+ tierPrices:
+ type: "array"
+ items:
+ $ref: "#/definitions/TierPrice"
+ AccountTimeline:
+ type: "object"
+ properties:
+ account:
+ $ref: "#/definitions/Account"
+ bundles:
+ type: "array"
+ items:
+ $ref: "#/definitions/Bundle"
+ invoices:
+ type: "array"
+ items:
+ $ref: "#/definitions/Invoice"
+ payments:
+ type: "array"
+ items:
+ $ref: "#/definitions/InvoicePayment"
+ Invoice:
+ type: "object"
+ properties:
+ amount:
+ type: "number"
+ currency:
+ type: "string"
+ enum:
+ - "AED"
+ - "AFN"
+ - "ALL"
+ - "AMD"
+ - "ANG"
+ - "AOA"
+ - "ARS"
+ - "AUD"
+ - "AWG"
+ - "AZN"
+ - "BAM"
+ - "BBD"
+ - "BDT"
+ - "BGN"
+ - "BHD"
+ - "BIF"
+ - "BMD"
+ - "BND"
+ - "BOB"
+ - "BRL"
- "BSD"
- "BTN"
- "BWP"
@@ -13590,74 +13633,125 @@ definitions:
- "ZMW"
- "ZWD"
- "BTC"
- parentAccountId:
+ status:
type: "string"
- format: "uuid"
- isPaymentDelegatedToParent:
- type: "boolean"
- paymentMethodId:
+ enum:
+ - "DRAFT"
+ - "COMMITTED"
+ - "VOID"
+ creditAdj:
+ type: "number"
+ refundAdj:
+ type: "number"
+ invoiceId:
type: "string"
format: "uuid"
- referenceTime:
- type: "string"
- format: "date-time"
- timeZone:
- type: "string"
- address1:
- type: "string"
- address2:
- type: "string"
- postalCode:
- type: "string"
- company:
+ invoiceDate:
type: "string"
- city:
+ format: "date"
+ targetDate:
type: "string"
- state:
+ format: "date"
+ invoiceNumber:
type: "string"
- country:
+ balance:
+ type: "number"
+ accountId:
type: "string"
- locale:
+ format: "uuid"
+ bundleKeys:
type: "string"
- phone:
+ 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"
- notes:
+ format: "uuid"
+ parentAccountId:
type: "string"
- isMigrated:
- type: "boolean"
- accountBalance:
- type: "number"
- accountCBA:
- type: "number"
+ format: "uuid"
auditLogs:
type: "array"
items:
$ref: "#/definitions/AuditLog"
- InvoicePayment:
+ InvoiceItem:
type: "object"
+ required:
+ - "accountId"
+ - "invoiceItemId"
properties:
- targetInvoiceId:
+ invoiceItemId:
+ type: "string"
+ format: "uuid"
+ invoiceId:
+ type: "string"
+ format: "uuid"
+ linkedInvoiceItemId:
type: "string"
format: "uuid"
accountId:
type: "string"
format: "uuid"
- paymentId:
+ childAccountId:
type: "string"
format: "uuid"
- paymentNumber:
+ bundleId:
type: "string"
- paymentExternalKey:
+ format: "uuid"
+ subscriptionId:
type: "string"
- authAmount:
- type: "number"
- capturedAmount:
- type: "number"
- purchasedAmount:
- type: "number"
- refundedAmount:
+ 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"
- creditedAmount:
+ rate:
type: "number"
currency:
type: "string"
@@ -13827,320 +13921,25 @@ definitions:
- "ZMW"
- "ZWD"
- "BTC"
- paymentMethodId:
+ quantity:
+ type: "number"
+ itemDetails:
type: "string"
- format: "uuid"
- transactions:
- type: "array"
- items:
- $ref: "#/definitions/PaymentTransaction"
- paymentAttempts:
+ catalogEffectiveDate:
+ type: "string"
+ format: "date-time"
+ childItems:
type: "array"
items:
- $ref: "#/definitions/PaymentAttempt"
+ $ref: "#/definitions/InvoiceItem"
auditLogs:
type: "array"
items:
$ref: "#/definitions/AuditLog"
- BlockPrice:
+ OverdueState:
type: "object"
properties:
- unitName:
- type: "string"
- size:
- type: "number"
- price:
- type: "number"
- max:
- type: "number"
- Bundle:
- type: "object"
- required:
- - "accountId"
- properties:
- accountId:
- type: "string"
- format: "uuid"
- bundleId:
- type: "string"
- format: "uuid"
- externalKey:
- type: "string"
- subscriptions:
- type: "array"
- items:
- $ref: "#/definitions/Subscription"
- timeline:
- $ref: "#/definitions/BundleTimeline"
- auditLogs:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
- BundleTimeline:
- type: "object"
- properties:
- accountId:
- type: "string"
- format: "uuid"
- bundleId:
- type: "string"
- format: "uuid"
- externalKey:
- type: "string"
- events:
- type: "array"
- items:
- $ref: "#/definitions/EventSubscription"
- auditLogs:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
- EventSubscription:
- type: "object"
- properties:
- eventId:
- type: "string"
- format: "uuid"
- billingPeriod:
- type: "string"
- enum:
- - "DAILY"
- - "WEEKLY"
- - "BIWEEKLY"
- - "THIRTY_DAYS"
- - "THIRTY_ONE_DAYS"
- - "SIXTY_DAYS"
- - "NINETY_DAYS"
- - "MONTHLY"
- - "BIMESTRIAL"
- - "QUARTERLY"
- - "TRIANNUAL"
- - "BIANNUAL"
- - "ANNUAL"
- - "SESQUIENNIAL"
- - "BIENNIAL"
- - "TRIENNIAL"
- - "NO_BILLING_PERIOD"
- effectiveDate:
- type: "string"
- format: "date-time"
- catalogEffectiveDate:
- type: "string"
- format: "date-time"
- plan:
- type: "string"
- product:
- type: "string"
- priceList:
- type: "string"
- eventType:
- type: "string"
- enum:
- - "START_ENTITLEMENT"
- - "START_BILLING"
- - "PAUSE_ENTITLEMENT"
- - "PAUSE_BILLING"
- - "RESUME_ENTITLEMENT"
- - "RESUME_BILLING"
- - "PHASE"
- - "CHANGE"
- - "STOP_ENTITLEMENT"
- - "STOP_BILLING"
- - "SERVICE_STATE_CHANGE"
- isBlockedBilling:
- type: "boolean"
- isBlockedEntitlement:
- type: "boolean"
- serviceName:
- type: "string"
- serviceStateName:
- type: "string"
- phase:
- type: "string"
- auditLogs:
- type: "array"
- items:
- $ref: "#/definitions/AuditLog"
- PhasePrice:
- type: "object"
- properties:
- planName:
- type: "string"
- phaseName:
- type: "string"
- phaseType:
- type: "string"
- fixedPrice:
- type: "number"
- recurringPrice:
- type: "number"
- usagePrices:
- type: "array"
- items:
- $ref: "#/definitions/UsagePrice"
- Subscription:
- type: "object"
- required:
- - "billingPeriod"
- - "planName"
- - "priceList"
- - "productName"
- properties:
- accountId:
- type: "string"
- format: "uuid"
- bundleId:
- type: "string"
- format: "uuid"
- bundleExternalKey:
- type: "string"
- subscriptionId:
- type: "string"
- format: "uuid"
- externalKey:
- type: "string"
- startDate:
- type: "string"
- format: "date-time"
- productName:
- type: "string"
- productCategory:
- type: "string"
- enum:
- - "BASE"
- - "ADD_ON"
- - "STANDALONE"
- billingPeriod:
- type: "string"
- enum:
- - "DAILY"
- - "WEEKLY"
- - "BIWEEKLY"
- - "THIRTY_DAYS"
- - "THIRTY_ONE_DAYS"
- - "SIXTY_DAYS"
- - "NINETY_DAYS"
- - "MONTHLY"
- - "BIMESTRIAL"
- - "QUARTERLY"
- - "TRIANNUAL"
- - "BIANNUAL"
- - "ANNUAL"
- - "SESQUIENNIAL"
- - "BIENNIAL"
- - "TRIENNIAL"
- - "NO_BILLING_PERIOD"
- phaseType:
- type: "string"
- enum:
- - "TRIAL"
- - "DISCOUNT"
- - "FIXEDTERM"
- - "EVERGREEN"
- priceList:
- type: "string"
- planName:
- type: "string"
- state:
- type: "string"
- enum:
- - "PENDING"
- - "ACTIVE"
- - "BLOCKED"
- - "CANCELLED"
- - "EXPIRED"
- sourceType:
- type: "string"
- enum:
- - "NATIVE"
- - "MIGRATED"
- - "TRANSFERRED"
- cancelledDate:
- type: "string"
- format: "date-time"
- chargedThroughDate:
- type: "string"
- format: "date"
- billingStartDate:
- type: "string"
- format: "date-time"
- billingEndDate:
- type: "string"
- format: "date-time"
- billCycleDayLocal:
- type: "integer"
- format: "int32"
- quantity:
- type: "integer"
- format: "int32"
- events:
- type: "array"
- items:
- $ref: "#/definitions/EventSubscription"
- priceOverrides:
- 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"
- OverdueState:
- type: "object"
- properties:
- name:
+ name:
type: "string"
externalMessage:
type: "string"
@@ -14153,60 +13952,29 @@ definitions:
reevaluationIntervalDays:
type: "integer"
format: "int32"
- AdminPayment:
- type: "object"
- properties:
- lastSuccessPaymentState:
- type: "string"
- currentPaymentStateName:
- type: "string"
- transactionStatus:
- type: "string"
- Duration:
- type: "object"
- properties:
- unit:
- type: "string"
- enum:
- - "DAYS"
- - "WEEKS"
- - "MONTHS"
- - "YEARS"
- - "UNLIMITED"
- number:
- type: "integer"
- format: "int32"
- Limit:
- type: "object"
- properties:
- unit:
- type: "string"
- max:
- type: "string"
- min:
- type: "string"
- Phase:
- type: "object"
- properties:
- type:
- type: "string"
- prices:
- type: "array"
- items:
- $ref: "#/definitions/Price"
- fixedPrices:
- type: "array"
- items:
- $ref: "#/definitions/Price"
- duration:
- $ref: "#/definitions/Duration"
- usages:
- type: "array"
- items:
- $ref: "#/definitions/Usage"
- Price:
+ Payment:
type: "object"
properties:
+ accountId:
+ type: "string"
+ format: "uuid"
+ paymentId:
+ type: "string"
+ format: "uuid"
+ paymentNumber:
+ type: "string"
+ paymentExternalKey:
+ type: "string"
+ authAmount:
+ type: "number"
+ capturedAmount:
+ type: "number"
+ purchasedAmount:
+ type: "number"
+ refundedAmount:
+ type: "number"
+ creditedAmount:
+ type: "number"
currency:
type: "string"
enum:
@@ -14375,115 +14143,30 @@ definitions:
- "ZMW"
- "ZWD"
- "BTC"
- value:
- type: "number"
- 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"
- Usage:
- type: "object"
- properties:
- billingPeriod:
+ paymentMethodId:
type: "string"
- tiers:
+ format: "uuid"
+ transactions:
type: "array"
items:
- $ref: "#/definitions/Tier"
- Plan:
- type: "object"
- properties:
- name:
- type: "string"
- prettyName:
- type: "string"
- recurringBillingMode:
- type: "string"
- enum:
- - "IN_ADVANCE"
- - "IN_ARREAR"
- billingPeriod:
- type: "string"
- enum:
- - "DAILY"
- - "WEEKLY"
- - "BIWEEKLY"
- - "THIRTY_DAYS"
- - "THIRTY_ONE_DAYS"
- - "SIXTY_DAYS"
- - "NINETY_DAYS"
- - "MONTHLY"
- - "BIMESTRIAL"
- - "QUARTERLY"
- - "TRIANNUAL"
- - "BIANNUAL"
- - "ANNUAL"
- - "SESQUIENNIAL"
- - "BIENNIAL"
- - "TRIENNIAL"
- - "NO_BILLING_PERIOD"
- phases:
+ $ref: "#/definitions/PaymentTransaction"
+ paymentAttempts:
type: "array"
items:
- $ref: "#/definitions/Phase"
- PriceList:
- type: "object"
- properties:
- name:
- type: "string"
- plans:
+ $ref: "#/definitions/PaymentAttempt"
+ auditLogs:
type: "array"
items:
- type: "string"
- Product:
+ $ref: "#/definitions/AuditLog"
+ AdminPayment:
type: "object"
properties:
- type:
+ lastSuccessPaymentState:
type: "string"
- name:
+ currentPaymentStateName:
type: "string"
- prettyName:
+ transactionStatus:
type: "string"
- plans:
- type: "array"
- items:
- $ref: "#/definitions/Plan"
- included:
- type: "array"
- items:
- type: "string"
- available:
- type: "array"
- items:
- type: "string"
SimplePlan:
type: "object"
properties:
@@ -14735,6 +14418,179 @@ definitions:
type: "array"
items:
$ref: "#/definitions/Price"
+ Price:
+ type: "object"
+ properties:
+ currency:
+ type: "string"
+ enum:
+ - "AED"
+ - "AFN"
+ - "ALL"
+ - "AMD"
+ - "ANG"
+ - "AOA"
+ - "ARS"
+ - "AUD"
+ - "AWG"
+ - "AZN"
+ - "BAM"
+ - "BBD"
+ - "BDT"
+ - "BGN"
+ - "BHD"
+ - "BIF"
+ - "BMD"
+ - "BND"
+ - "BOB"
+ - "BRL"
+ - "BSD"
+ - "BTN"
+ - "BWP"
+ - "BYR"
+ - "BZD"
+ - "CAD"
+ - "CDF"
+ - "CHF"
+ - "CLP"
+ - "CNY"
+ - "COP"
+ - "CRC"
+ - "CUC"
+ - "CUP"
+ - "CVE"
+ - "CZK"
+ - "DJF"
+ - "DKK"
+ - "DOP"
+ - "DZD"
+ - "EGP"
+ - "ERN"
+ - "ETB"
+ - "EUR"
+ - "FJD"
+ - "FKP"
+ - "GBP"
+ - "GEL"
+ - "GGP"
+ - "GHS"
+ - "GIP"
+ - "GMD"
+ - "GNF"
+ - "GTQ"
+ - "GYD"
+ - "HKD"
+ - "HNL"
+ - "HRK"
+ - "HTG"
+ - "HUF"
+ - "IDR"
+ - "ILS"
+ - "IMP"
+ - "INR"
+ - "IQD"
+ - "IRR"
+ - "ISK"
+ - "JEP"
+ - "JMD"
+ - "JOD"
+ - "JPY"
+ - "KES"
+ - "KGS"
+ - "KHR"
+ - "KMF"
+ - "KPW"
+ - "KRW"
+ - "KWD"
+ - "KYD"
+ - "KZT"
+ - "LAK"
+ - "LBP"
+ - "LKR"
+ - "LRD"
+ - "LSL"
+ - "LTL"
+ - "LVL"
+ - "LYD"
+ - "MAD"
+ - "MDL"
+ - "MGA"
+ - "MKD"
+ - "MMK"
+ - "MNT"
+ - "MOP"
+ - "MRO"
+ - "MUR"
+ - "MVR"
+ - "MWK"
+ - "MXN"
+ - "MYR"
+ - "MZN"
+ - "NAD"
+ - "NGN"
+ - "NIO"
+ - "NOK"
+ - "NPR"
+ - "NZD"
+ - "OMR"
+ - "PAB"
+ - "PEN"
+ - "PGK"
+ - "PHP"
+ - "PKR"
+ - "PLN"
+ - "PYG"
+ - "QAR"
+ - "RON"
+ - "RSD"
+ - "RUB"
+ - "RWF"
+ - "SAR"
+ - "SBD"
+ - "SCR"
+ - "SDG"
+ - "SEK"
+ - "SGD"
+ - "SHP"
+ - "SLL"
+ - "SOS"
+ - "SPL"
+ - "SRD"
+ - "STD"
+ - "SVC"
+ - "SYP"
+ - "SZL"
+ - "THB"
+ - "TJS"
+ - "TMT"
+ - "TND"
+ - "TOP"
+ - "TRY"
+ - "TTD"
+ - "TVD"
+ - "TWD"
+ - "TZS"
+ - "UAH"
+ - "UGX"
+ - "USD"
+ - "UYU"
+ - "UZS"
+ - "VEF"
+ - "VND"
+ - "VUV"
+ - "WST"
+ - "XAF"
+ - "XCD"
+ - "XDR"
+ - "XOF"
+ - "XPF"
+ - "YER"
+ - "ZAR"
+ - "ZMW"
+ - "ZWD"
+ - "BTC"
+ value:
+ type: "number"
Catalog:
type: "object"
properties:
@@ -14925,6 +14781,146 @@ definitions:
type: "array"
items:
$ref: "#/definitions/PriceList"
+ Duration:
+ type: "object"
+ properties:
+ unit:
+ type: "string"
+ enum:
+ - "DAYS"
+ - "WEEKS"
+ - "MONTHS"
+ - "YEARS"
+ - "UNLIMITED"
+ number:
+ type: "integer"
+ format: "int32"
+ Limit:
+ type: "object"
+ properties:
+ unit:
+ type: "string"
+ max:
+ type: "string"
+ min:
+ type: "string"
+ Phase:
+ type: "object"
+ properties:
+ type:
+ type: "string"
+ prices:
+ type: "array"
+ items:
+ $ref: "#/definitions/Price"
+ fixedPrices:
+ type: "array"
+ items:
+ $ref: "#/definitions/Price"
+ duration:
+ $ref: "#/definitions/Duration"
+ usages:
+ type: "array"
+ items:
+ $ref: "#/definitions/Usage"
+ Plan:
+ type: "object"
+ properties:
+ name:
+ type: "string"
+ prettyName:
+ type: "string"
+ recurringBillingMode:
+ type: "string"
+ enum:
+ - "IN_ADVANCE"
+ - "IN_ARREAR"
+ billingPeriod:
+ type: "string"
+ enum:
+ - "DAILY"
+ - "WEEKLY"
+ - "BIWEEKLY"
+ - "THIRTY_DAYS"
+ - "THIRTY_ONE_DAYS"
+ - "SIXTY_DAYS"
+ - "NINETY_DAYS"
+ - "MONTHLY"
+ - "BIMESTRIAL"
+ - "QUARTERLY"
+ - "TRIANNUAL"
+ - "BIANNUAL"
+ - "ANNUAL"
+ - "SESQUIENNIAL"
+ - "BIENNIAL"
+ - "TRIENNIAL"
+ - "NO_BILLING_PERIOD"
+ phases:
+ type: "array"
+ items:
+ $ref: "#/definitions/Phase"
+ PriceList:
+ type: "object"
+ properties:
+ name:
+ type: "string"
+ plans:
+ type: "array"
+ items:
+ type: "string"
+ Product:
+ type: "object"
+ properties:
+ type:
+ type: "string"
+ name:
+ type: "string"
+ prettyName:
+ type: "string"
+ plans:
+ type: "array"
+ items:
+ $ref: "#/definitions/Plan"
+ included:
+ type: "array"
+ items:
+ type: "string"
+ available:
+ type: "array"
+ items:
+ type: "string"
+ Tier:
+ type: "object"
+ properties:
+ limits:
+ type: "array"
+ items:
+ $ref: "#/definitions/Limit"
+ fixedPrice:
+ type: "array"
+ items:
+ $ref: "#/definitions/Price"
+ recurringPrice:
+ 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:
@@ -14932,6 +14928,15 @@ definitions:
type: "string"
prettyName:
type: "string"
+ Usage:
+ type: "object"
+ properties:
+ billingPeriod:
+ type: "string"
+ tiers:
+ type: "array"
+ items:
+ $ref: "#/definitions/Tier"
CatalogValidation:
type: "object"
properties:
@@ -15427,6 +15432,24 @@ definitions:
$ref: "#/definitions/PhasePrice"
planName:
type: "string"
+ NodeCommand:
+ type: "object"
+ properties:
+ isSystemCommandType:
+ type: "boolean"
+ nodeCommandType:
+ type: "string"
+ nodeCommandProperties:
+ type: "array"
+ items:
+ $ref: "#/definitions/NodeCommandProperty"
+ NodeCommandProperty:
+ type: "object"
+ properties:
+ key:
+ type: "string"
+ value:
+ type: "object"
NodeInfo:
type: "object"
properties:
@@ -15479,24 +15502,6 @@ definitions:
type: "string"
registrationName:
type: "string"
- NodeCommand:
- type: "object"
- properties:
- isSystemCommandType:
- type: "boolean"
- nodeCommandType:
- type: "string"
- nodeCommandProperties:
- type: "array"
- items:
- $ref: "#/definitions/NodeCommandProperty"
- NodeCommandProperty:
- type: "object"
- properties:
- key:
- type: "string"
- value:
- type: "object"
Overdue:
type: "object"
properties:
@@ -15754,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:
@@ -15786,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 8cdc226..27731d3 100644
--- a/pom.xml
+++ b/pom.xml
@@ -22,7 +22,7 @@
org.kill-bill.billing
killbill-oss-parent
- 0.146.66
+ 0.146.76
killbill-client-java
1.4.0-SNAPSHOT
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 303bd6b..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
@@ -105,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/CreditApi.java b/src/main/java/org/killbill/billing/client/api/gen/CreditApi.java
index 90e5324..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,6 +23,7 @@
import java.util.Objects;
import org.killbill.billing.client.model.gen.InvoiceItem;
+import java.time.LocalDate;
import java.util.UUID;
import org.killbill.billing.client.model.InvoiceItems;
import java.util.List;
@@ -58,16 +59,19 @@ public CreditApi(final KillBillHttpClient httpClient) {
this.httpClient = httpClient;
}
- public InvoiceItems createCredits(final InvoiceItems body, final Map pluginProperty, final RequestOptions inputOptions) throws KillBillClientException {
- return createCredits(body, Boolean.valueOf(false), pluginProperty, inputOptions);
+ public InvoiceItems createCredits(final InvoiceItems body, final LocalDate requestedDate, final Map pluginProperty, final RequestOptions inputOptions) throws KillBillClientException {
+ return createCredits(body, requestedDate, Boolean.valueOf(false), pluginProperty, inputOptions);
}
- public InvoiceItems createCredits(final InvoiceItems body, final Boolean autoCommit, final Map pluginProperty, final RequestOptions inputOptions) throws KillBillClientException {
+ public InvoiceItems createCredits(final InvoiceItems body, final LocalDate requestedDate, final Boolean autoCommit, final Map pluginProperty, final RequestOptions inputOptions) throws KillBillClientException {
Preconditions.checkNotNull(body, "Missing the required parameter 'body' when calling createCredits");
final String uri = "/1.0/kb/credits";
final Multimap queryParams = new TreeMapSetMultimap<>(inputOptions.getQueryParams());
+ if (requestedDate != null) {
+ queryParams.put("requestedDate", String.valueOf(requestedDate));
+ }
if (autoCommit != null) {
queryParams.put("autoCommit", String.valueOf(autoCommit));
}
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 98b5b28..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
@@ -109,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));
@@ -180,7 +180,7 @@ public void cancelSubscriptionPlan(final UUID subscriptionId, final ZonedDateTim
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));
@@ -259,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));
@@ -340,10 +340,10 @@ public Subscription createSubscription(final Subscription body, final ZonedDateT
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));
@@ -468,10 +468,10 @@ public Bundle createSubscriptionWithAddOns(final Subscriptions body, final Zoned
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));