killbill.AdminApi

All URIs are relative to /

Method	HTTP request	Description
get_queue_entries	GET /1.0/kb/admin/queues	Get queues entries
invalidates_cache	DELETE /1.0/kb/admin/cache	Invalidates the given Cache if specified, otherwise invalidates all caches
invalidates_cache_by_account	DELETE /1.0/kb/admin/cache/accounts/{accountId}	Invalidates Caches per account level
invalidates_cache_by_tenant	DELETE /1.0/kb/admin/cache/tenants	Invalidates Caches per tenant level
put_in_rotation	PUT /1.0/kb/admin/healthcheck	Put the host back into rotation
put_out_of_rotation	DELETE /1.0/kb/admin/healthcheck	Put the host out of rotation
trigger_invoice_generation_for_parked_accounts	POST /1.0/kb/admin/invoices	Trigger an invoice generation for all parked accounts
update_payment_transaction_state	PUT /1.0/kb/admin/payments/{paymentId}/transactions/{paymentTransactionId}	Update existing paymentTransaction and associated payment state

get_queue_entries

get_queue_entries(account_id=account_id, queue_name=queue_name, service_name=service_name, with_history=with_history, min_date=min_date, max_date=max_date, with_in_processing=with_in_processing, with_bus_events=with_bus_events, with_notifications=with_notifications)

Get queues entries

Example

from __future__ import print_function
import time
import killbill
from killbill.rest import ApiException
from pprint import pprint

# Configure API key authorization: Killbill Api Key
configuration = killbill.Configuration()
configuration.api_key['X-Killbill-ApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Killbill-ApiKey'] = 'Bearer'
# Configure API key authorization: Killbill Api Secret
configuration = killbill.Configuration()
configuration.api_key['X-Killbill-ApiSecret'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Killbill-ApiSecret'] = 'Bearer'# Configure HTTP basic authorization: basicAuth
configuration = killbill.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = killbill.AdminApi(killbill.ApiClient(configuration))
account_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str |  (optional)
queue_name = 'queue_name_example' # str |  (optional)
service_name = 'service_name_example' # str |  (optional)
with_history = true # bool |  (optional) (default to true)
min_date = 'min_date_example' # str |  (optional)
max_date = 'max_date_example' # str |  (optional)
with_in_processing = true # bool |  (optional) (default to true)
with_bus_events = true # bool |  (optional) (default to true)
with_notifications = true # bool |  (optional) (default to true)

try:
    # Get queues entries
    api_instance.get_queue_entries(account_id=account_id, queue_name=queue_name, service_name=service_name, with_history=with_history, min_date=min_date, max_date=max_date, with_in_processing=with_in_processing, with_bus_events=with_bus_events, with_notifications=with_notifications)
except ApiException as e:
    print("Exception when calling AdminApi->get_queue_entries: %s\n" % e)

Parameters

Name	Type	Notes
account_id	str	[optional]
queue_name	str	[optional]
service_name	str	[optional]
with_history	bool	[optional] [default to true]
min_date	str	[optional]
max_date	str	[optional]
with_in_processing	bool	[optional] [default to true]
with_bus_events	bool	[optional] [default to true]
with_notifications	bool	[optional] [default to true]

Return type

void (empty response body)

Authorization

[Killbill Api Key](../README.md#Killbill Api Key), [Killbill Api Secret](../README.md#Killbill Api Secret), basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

invalidates_cache

invalidates_cache(cache_name=cache_name)

Invalidates the given Cache if specified, otherwise invalidates all caches

Example

from __future__ import print_function
import time
import killbill
from killbill.rest import ApiException
from pprint import pprint

# Configure API key authorization: Killbill Api Key
configuration = killbill.Configuration()
configuration.api_key['X-Killbill-ApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Killbill-ApiKey'] = 'Bearer'
# Configure API key authorization: Killbill Api Secret
configuration = killbill.Configuration()
configuration.api_key['X-Killbill-ApiSecret'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Killbill-ApiSecret'] = 'Bearer'# Configure HTTP basic authorization: basicAuth
configuration = killbill.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = killbill.AdminApi(killbill.ApiClient(configuration))
cache_name = 'cache_name_example' # str |  (optional)

try:
    # Invalidates the given Cache if specified, otherwise invalidates all caches
    api_instance.invalidates_cache(cache_name=cache_name)
except ApiException as e:
    print("Exception when calling AdminApi->invalidates_cache: %s\n" % e)

Parameters

Name	Type	Description	Notes
cache_name	str		[optional]

Return type

void (empty response body)

Authorization

[Killbill Api Key](../README.md#Killbill Api Key), [Killbill Api Secret](../README.md#Killbill Api Secret), basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

invalidates_cache_by_account

invalidates_cache_by_account(account_id)

Invalidates Caches per account level

Example

from __future__ import print_function
import time
import killbill
from killbill.rest import ApiException
from pprint import pprint

# Configure API key authorization: Killbill Api Key
configuration = killbill.Configuration()
configuration.api_key['X-Killbill-ApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Killbill-ApiKey'] = 'Bearer'
# Configure API key authorization: Killbill Api Secret
configuration = killbill.Configuration()
configuration.api_key['X-Killbill-ApiSecret'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Killbill-ApiSecret'] = 'Bearer'# Configure HTTP basic authorization: basicAuth
configuration = killbill.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = killbill.AdminApi(killbill.ApiClient(configuration))
account_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 

try:
    # Invalidates Caches per account level
    api_instance.invalidates_cache_by_account(account_id)
except ApiException as e:
    print("Exception when calling AdminApi->invalidates_cache_by_account: %s\n" % e)

Parameters

Name	Type	Description	Notes
account_id	str

Return type

void (empty response body)

Authorization

[Killbill Api Key](../README.md#Killbill Api Key), [Killbill Api Secret](../README.md#Killbill Api Secret), basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

invalidates_cache_by_tenant

invalidates_cache_by_tenant()

Invalidates Caches per tenant level

Example

from __future__ import print_function
import time
import killbill
from killbill.rest import ApiException
from pprint import pprint

# Configure API key authorization: Killbill Api Key
configuration = killbill.Configuration()
configuration.api_key['X-Killbill-ApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Killbill-ApiKey'] = 'Bearer'
# Configure API key authorization: Killbill Api Secret
configuration = killbill.Configuration()
configuration.api_key['X-Killbill-ApiSecret'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Killbill-ApiSecret'] = 'Bearer'# Configure HTTP basic authorization: basicAuth
configuration = killbill.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = killbill.AdminApi(killbill.ApiClient(configuration))

try:
    # Invalidates Caches per tenant level
    api_instance.invalidates_cache_by_tenant()
except ApiException as e:
    print("Exception when calling AdminApi->invalidates_cache_by_tenant: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

[Killbill Api Key](../README.md#Killbill Api Key), [Killbill Api Secret](../README.md#Killbill Api Secret), basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

put_in_rotation

put_in_rotation()

Put the host back into rotation

Example

from __future__ import print_function
import time
import killbill
from killbill.rest import ApiException
from pprint import pprint

# Configure API key authorization: Killbill Api Key
configuration = killbill.Configuration()
configuration.api_key['X-Killbill-ApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Killbill-ApiKey'] = 'Bearer'
# Configure API key authorization: Killbill Api Secret
configuration = killbill.Configuration()
configuration.api_key['X-Killbill-ApiSecret'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Killbill-ApiSecret'] = 'Bearer'# Configure HTTP basic authorization: basicAuth
configuration = killbill.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = killbill.AdminApi(killbill.ApiClient(configuration))

try:
    # Put the host back into rotation
    api_instance.put_in_rotation()
except ApiException as e:
    print("Exception when calling AdminApi->put_in_rotation: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

[Killbill Api Key](../README.md#Killbill Api Key), [Killbill Api Secret](../README.md#Killbill Api Secret), basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

put_out_of_rotation

put_out_of_rotation()

Put the host out of rotation

Example

from __future__ import print_function
import time
import killbill
from killbill.rest import ApiException
from pprint import pprint

# Configure API key authorization: Killbill Api Key
configuration = killbill.Configuration()
configuration.api_key['X-Killbill-ApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Killbill-ApiKey'] = 'Bearer'
# Configure API key authorization: Killbill Api Secret
configuration = killbill.Configuration()
configuration.api_key['X-Killbill-ApiSecret'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Killbill-ApiSecret'] = 'Bearer'# Configure HTTP basic authorization: basicAuth
configuration = killbill.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = killbill.AdminApi(killbill.ApiClient(configuration))

try:
    # Put the host out of rotation
    api_instance.put_out_of_rotation()
except ApiException as e:
    print("Exception when calling AdminApi->put_out_of_rotation: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

[Killbill Api Key](../README.md#Killbill Api Key), [Killbill Api Secret](../README.md#Killbill Api Secret), basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

trigger_invoice_generation_for_parked_accounts

trigger_invoice_generation_for_parked_accounts(x_killbill_created_by, offset=offset, limit=limit, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)

Trigger an invoice generation for all parked accounts

Example

from __future__ import print_function
import time
import killbill
from killbill.rest import ApiException
from pprint import pprint

# Configure API key authorization: Killbill Api Key
configuration = killbill.Configuration()
configuration.api_key['X-Killbill-ApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Killbill-ApiKey'] = 'Bearer'
# Configure API key authorization: Killbill Api Secret
configuration = killbill.Configuration()
configuration.api_key['X-Killbill-ApiSecret'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Killbill-ApiSecret'] = 'Bearer'# Configure HTTP basic authorization: basicAuth
configuration = killbill.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = killbill.AdminApi(killbill.ApiClient(configuration))
x_killbill_created_by = 'x_killbill_created_by_example' # str | 
offset = 0 # int |  (optional) (default to 0)
limit = 100 # int |  (optional) (default to 100)
x_killbill_reason = 'x_killbill_reason_example' # str |  (optional)
x_killbill_comment = 'x_killbill_comment_example' # str |  (optional)

try:
    # Trigger an invoice generation for all parked accounts
    api_instance.trigger_invoice_generation_for_parked_accounts(x_killbill_created_by, offset=offset, limit=limit, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)
except ApiException as e:
    print("Exception when calling AdminApi->trigger_invoice_generation_for_parked_accounts: %s\n" % e)

Parameters

Name	Type	Notes
x_killbill_created_by	str
offset	int	[optional] [default to 0]
limit	int	[optional] [default to 100]
x_killbill_reason	str	[optional]
x_killbill_comment	str	[optional]

Return type

void (empty response body)

Authorization

[Killbill Api Key](../README.md#Killbill Api Key), [Killbill Api Secret](../README.md#Killbill Api Secret), basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_payment_transaction_state

update_payment_transaction_state(body, x_killbill_created_by, payment_id, payment_transaction_id, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)

Update existing paymentTransaction and associated payment state

Example

from __future__ import print_function
import time
import killbill
from killbill.rest import ApiException
from pprint import pprint

# Configure API key authorization: Killbill Api Key
configuration = killbill.Configuration()
configuration.api_key['X-Killbill-ApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Killbill-ApiKey'] = 'Bearer'
# Configure API key authorization: Killbill Api Secret
configuration = killbill.Configuration()
configuration.api_key['X-Killbill-ApiSecret'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Killbill-ApiSecret'] = 'Bearer'# Configure HTTP basic authorization: basicAuth
configuration = killbill.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = killbill.AdminApi(killbill.ApiClient(configuration))
body = killbill.AdminPayment() # AdminPayment | 
x_killbill_created_by = 'x_killbill_created_by_example' # str | 
payment_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 
payment_transaction_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 
x_killbill_reason = 'x_killbill_reason_example' # str |  (optional)
x_killbill_comment = 'x_killbill_comment_example' # str |  (optional)

try:
    # Update existing paymentTransaction and associated payment state
    api_instance.update_payment_transaction_state(body, x_killbill_created_by, payment_id, payment_transaction_id, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)
except ApiException as e:
    print("Exception when calling AdminApi->update_payment_transaction_state: %s\n" % e)

Parameters

Name	Type	Notes
body	AdminPayment
x_killbill_created_by	str
payment_id	str
payment_transaction_id	str
x_killbill_reason	str	[optional]
x_killbill_comment	str	[optional]

Return type

void (empty response body)

Authorization

[Killbill Api Key](../README.md#Killbill Api Key), [Killbill Api Secret](../README.md#Killbill Api Secret), basicAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

AdminApi.md

Latest commit

History

AdminApi.md

File metadata and controls

killbill.AdminApi

get_queue_entries

Example

Parameters

Return type

Authorization

HTTP request headers

invalidates_cache

Example

Parameters

Return type

Authorization

HTTP request headers

invalidates_cache_by_account

Example

Parameters

Return type

Authorization

HTTP request headers

invalidates_cache_by_tenant

Example

Parameters

Return type

Authorization

HTTP request headers

put_in_rotation

Example

Parameters

Return type

Authorization

HTTP request headers

put_out_of_rotation

Example

Parameters

Return type

Authorization

HTTP request headers

trigger_invoice_generation_for_parked_accounts

Example

Parameters

Return type

Authorization

HTTP request headers

update_payment_transaction_state

Example

Parameters

Return type

Authorization

HTTP request headers