/
KI
killbill
/
Kill Bill
Search skmtc…
⌘K
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Subscribe
v1
latest
Swagger 2.0
Apache License, Version 2.0
2026-07-17
258
67
524.8 KB
Account
Retrieve account tags
get
/1.0/kb/accounts/{accountId}/tags
Path parameters
accountId
string
uuid
required
Query parameters
includedDeleted
boolean
audit
'FULL'
|
'MINIMAL'
|
'NONE'
Response
successful operation
Tag[]
required
tagId
string
uuid
objectType
'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
string
uuid
tagDefinitionId
string
uuid
tagDefinitionName
string
auditLogs
AuditLog[]
All 258 operations
get
Retrieve account tags
post
Add tags to account
delete
Remove tags from account
get
Retrieve account custom fields
put
Modify custom fields to account
post
Add custom fields to account
delete
Remove custom fields from account
get
Retrieve blocking states for account
post
Block an account
get
Retrieve audit logs by account id
get
Retrieve an account by id
put
Update account
delete
Close account
get
Retrieve an account by external key
post
Create account
get
Retrieve an account emails
post
Add account email
get
List accounts
get
Search accounts
get
Retrieve bundles for account
get
Retrieve account timeline
put
Rebalance account CBA
get
Retrieve account invoices
get
Retrieve account invoice payments
post
Trigger a payment for all unpaid invoices
get
Retrieve account payment methods
post
Add a payment method
put
Refresh account payment methods
put
Set the default payment method
get
Retrieve account payments
post
Trigger a payment (authorization, purchase or credit)
post
Trigger a payment using the account external key (authorization, purchase or credit)
get
Retrieve overdue state for account
get
Retrieve blocking state audit logs with history by id
get
Retrieve account customFields
get
Retrieve account tags
delete
Delete email from account
get
Retrieve account email audit logs with history by id
get
List children accounts
put
Move a given child credit to the parent level
get
Retrieve account audit logs with history by account id
get
Get queues entries
put
Update existing paymentTransaction and associated payment state
post
Trigger an invoice generation for all parked accounts
delete
Invalidates the given Cache if specified, otherwise invalidates all caches
delete
Invalidates Caches per account level
delete
Invalidates Caches per tenant level
put
Put the host back into rotation
delete
Put the host out of rotation
get
Retrieve a bundle by id
post
Transfer a bundle to another account
get
Retrieve bundle tags
post
Add tags to bundle
delete
Remove tags from bundle
get
Retrieve bundle custom fields
put
Modify custom fields to bundle
post
Add custom fields to bundle
delete
Remove custom fields from bundle
get
Retrieve a bundle by external key
get
Retrieve bundle audit logs with history by id
get
List bundles
get
Search bundles
put
Pause a bundle
put
Resume a bundle
post
Block a bundle
put
Update a bundle externalKey
get
Retrieve the full catalog as XML
post
Upload the full catalog as XML
get
Retrieve the catalog as JSON
delete
Delete all versions for a per tenant catalog
get
Retrieve a list of catalog versions
get
Retrieve available add-ons for a given product
get
Retrieve available base plans
get
Retrieve plan for a given subscription and date
get
Retrieve phase for a given subscription and date
get
Retrieve product for a given subscription and date
get
Retrieve priceList for a given subscription and date
post
Add a simple plan entry in the current version of the catalog
get
Retrieve a credit by id
post
Create a credit
get
List custom fields
get
Retrieve custom field audit logs with history by id
get
Search custom fields by type, name and optional value
get
Search custom fields
get
Export account data
get
Retrieve invoice item tags
post
Add tags to invoice item
delete
Remove tags from invoice item
get
Retrieve invoice item custom fields
put
Modify custom fields to invoice item
post
Add custom fields to invoice item
delete
Remove custom fields from invoice item
get
Retrieve invoice item audit logs with history by id
get
Retrieve payment tags
post
Add tags to payment
delete
Remove tags from payment
get
Retrieve payment custom fields
put
Modify custom fields to payment
post
Add custom fields to payment
delete
Remove custom fields from payment
get
Retrieve a payment by id
put
Complete an existing transaction
get
Retrieve invoice payment audit logs with history by id
post
Refund a payment, and adjust the invoice if needed
post
Record a chargeback
post
Record a chargebackReversal
post
Create tax items
post
Create a migration invoice
post
Generate a dryRun invoice
delete
Delete a CBA item
get
Retrieve an invoice by id
post
Adjust an invoice item
post
Create external charge(s)
get
Retrieve payments associated with an invoice
post
Trigger a payment for invoice
get
Retrieve invoice audit logs with history by id
get
Retrieve an invoice by number
get
Retrieves the invoice translation for the tenant
post
Upload the invoice translation for the tenant
get
Retrieves the catalog translation for the tenant
post
Upload the catalog translation for the tenant
get
Retrieves the invoice template for the tenant
post
Upload the invoice template for the tenant
get
Retrieves the manualPay invoice template for the tenant
post
Upload the manualPay invoice template for the tenant
get
Retrieve an invoice by invoice item id
get
Render an invoice as HTML
get
List invoices
get
Search invoices
post
Trigger an invoice generation
get
Retrieve invoice tags
post
Add tags to invoice
delete
Remove tags from invoice
get
Retrieve invoice custom fields
put
Modify custom fields to invoice
post
Add custom fields to invoice
delete
Remove custom fields from invoice
put
Perform the invoice status transition from DRAFT to COMMITTED
put
Perform the action of voiding an invoice
get
Retrieve all the nodes infos
post
Trigger a node command
get
Retrieve the overdue config as XML
post
Upload the full overdue config as XML
get
Retrieve the overdue config as JSON
post
Upload the full overdue config as JSON
post
Process a gateway notification
post
Combo API to generate form data to redirect the customer to the gateway
post
Generate form data to redirect the customer to the gateway
get
Retrieve payment method custom fields
put
Modify custom fields to payment method
post
Add custom fields to payment method
delete
Remove custom fields from payment method
get
Retrieve a payment method by id
delete
Delete a payment method
get
Search payment methods
get
Retrieve payment method audit logs with history by id
get
List payment methods
get
Retrieve a payment method by external key
get
Retrieve payment payment tags
post
Add tags to payment payment
delete
Remove tags from payment payment
get
Retrieve payment custom fields
put
Modify custom fields to payment
post
Add custom fields to payment
delete
Remove custom fields from payment payment
get
Retrieve a payment by id
put
Complete an existing transaction
post
Capture an existing authorization
delete
Void an existing payment
get
Retrieve a payment by external key
put
Complete an existing transaction
post
Capture an existing authorization
delete
Void an existing payment
get
Get payments
get
Search payments
post
Refund an existing payment
post
Refund an existing payment
post
Record a chargeback
post
Record a chargeback
post
Record a chargeback reversal
post
Record a chargeback reversal
post
Combo api to create a new payment transaction on a existing (or not) account
delete
Cancels a scheduled payment attempt retry
delete
Cancels a scheduled payment attempt retry
get
Retrieve payment audit logs with history by id
get
Retrieve payment attempt audit logs with history by id
get
Retrieve the list of registered plugins
get
Get user information
post
Add a new user with roles (to make api requests)
put
Update a user password
get
Get roles associated to a user
put
Update roles associated to a user
delete
Invalidate an existing user
get
Get role definition
put
Update a new role definition)
post
Add a new role definition)
get
List user permissions
get
Retrieve subscription tags
post
/1.0/kb/subscriptions/{subscriptionId}/tags
delete
Remove tags from subscription
get
Retrieve subscription custom fields
put
Modify custom fields to subscription
post
Add custom fields to subscription
delete
Remove custom fields from subscription
get
Retrieve a subscription by id
put
Change entitlement plan
delete
Cancel an entitlement plan
get
Retrieve a subscription by external key
post
Create an subscription
get
Retrieve subscription audit logs with history by id
get
Retrieve subscription event audit logs with history by id
post
Create an entitlement with addOn products
post
Create multiple entitlements with addOn products
put
Un-cancel an entitlement
put
Undo a pending change plan on an entitlement
post
Block a subscription
put
Update the BCD associated to a subscription
get
Retrieve a tag definition
delete
Delete a tag definition
get
List tag definitions
post
Create a tag definition
get
Retrieve tag definition audit logs with history by id
get
List tags
get
Retrieve tag audit logs with history by id
get
Search tags
get
Retrieve a per tenant payment state machine for a plugin
post
Add a per tenant payment state machine for a plugin
delete
Delete a per tenant payment state machine for a plugin
get
Retrieve a tenant by id
get
Retrieve a tenant by its API key
post
Create a tenant
get
Retrieve a push notification
post
Create a push notification
delete
Delete a push notification
get
Retrieve a per tenant configuration for a plugin
post
Add a per tenant configuration for a plugin
delete
Delete a per tenant configuration for a plugin
get
Retrieve a per tenant key value based on key prefix
get
Retrieve a per tenant configuration (system properties)
post
Add a per tenant configuration (system properties)
delete
Delete a per tenant configuration (system properties)
get
Retrieve a per tenant user key/value
post
Add a per tenant user key/value
delete
Delete a per tenant user key/value
get
Retrieve a payment by transaction id
post
Mark a pending payment transaction as succeeded or failed
get
Retrieve payment transaction custom fields
put
Modify custom fields to payment transaction
post
Add custom fields to payment transaction
delete
Remove custom fields from payment transaction
get
Retrieve payment transaction tags
post
Add tags to payment transaction
delete
Remove tags from payment transaction
get
Retrieve payment transaction audit logs with history by id
get
Retrieve a payment by transaction external key
get
Retrieve usage for a subscription and unit type
post
Record usage for a subscription
get
Retrieve usage for a subscription