killbill.CatalogApi

All URIs are relative to /

Method	HTTP request	Description
add_simple_plan	POST /1.0/kb/catalog/simplePlan	Add a simple plan entry in the current version of the catalog
delete_catalog	DELETE /1.0/kb/catalog	Delete all versions for a per tenant catalog
get_available_addons	GET /1.0/kb/catalog/availableAddons	Retrieve available add-ons for a given product
get_available_base_plans	GET /1.0/kb/catalog/availableBasePlans	Retrieve available base plans
get_catalog_json	GET /1.0/kb/catalog	Retrieve the catalog as JSON
get_catalog_versions	GET /1.0/kb/catalog/versions	Retrieve a list of catalog versions
get_catalog_xml	GET /1.0/kb/catalog/xml	Retrieve the full catalog as XML
get_phase_for_subscription_and_date	GET /1.0/kb/catalog/phase	Retrieve phase for a given subscription and date
get_plan_for_subscription_and_date	GET /1.0/kb/catalog/plan	Retrieve plan for a given subscription and date
get_price_list_for_subscription_and_date	GET /1.0/kb/catalog/priceList	Retrieve priceList for a given subscription and date
get_product_for_subscription_and_date	GET /1.0/kb/catalog/product	Retrieve product for a given subscription and date
upload_catalog_xml	POST /1.0/kb/catalog/xml	Upload the full catalog as XML

add_simple_plan

str add_simple_plan(body, x_killbill_created_by, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)

Add a simple plan entry in the current version of the catalog

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.CatalogApi(killbill.ApiClient(configuration))
body = killbill.SimplePlan() # SimplePlan | 
x_killbill_created_by = 'x_killbill_created_by_example' # str | 
x_killbill_reason = 'x_killbill_reason_example' # str |  (optional)
x_killbill_comment = 'x_killbill_comment_example' # str |  (optional)

try:
    # Add a simple plan entry in the current version of the catalog
    api_response = api_instance.add_simple_plan(body, x_killbill_created_by, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogApi->add_simple_plan: %s\n" % e)

Parameters

Name	Type	Notes
body	SimplePlan
x_killbill_created_by	str
x_killbill_reason	str	[optional]
x_killbill_comment	str	[optional]

Return type

str

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: application/json

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

delete_catalog

delete_catalog(x_killbill_created_by, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)

Delete all versions for a per tenant catalog

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.CatalogApi(killbill.ApiClient(configuration))
x_killbill_created_by = 'x_killbill_created_by_example' # str | 
x_killbill_reason = 'x_killbill_reason_example' # str |  (optional)
x_killbill_comment = 'x_killbill_comment_example' # str |  (optional)

try:
    # Delete all versions for a per tenant catalog
    api_instance.delete_catalog(x_killbill_created_by, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)
except ApiException as e:
    print("Exception when calling CatalogApi->delete_catalog: %s\n" % e)

Parameters

Name	Type	Notes
x_killbill_created_by	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: Not defined
Accept: Not defined

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

get_available_addons

list[PlanDetail] get_available_addons(base_product_name=base_product_name, price_list_name=price_list_name, account_id=account_id)

Retrieve available add-ons for a given product

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.CatalogApi(killbill.ApiClient(configuration))
base_product_name = 'base_product_name_example' # str |  (optional)
price_list_name = 'price_list_name_example' # str |  (optional)
account_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str |  (optional)

try:
    # Retrieve available add-ons for a given product
    api_response = api_instance.get_available_addons(base_product_name=base_product_name, price_list_name=price_list_name, account_id=account_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogApi->get_available_addons: %s\n" % e)

Parameters

Name	Type	Notes
base_product_name	str	[optional]
price_list_name	str	[optional]
account_id	str	[optional]

Return type

list[PlanDetail]

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: application/json

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

get_available_base_plans

list[PlanDetail] get_available_base_plans(account_id=account_id)

Retrieve available base plans

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.CatalogApi(killbill.ApiClient(configuration))
account_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str |  (optional)

try:
    # Retrieve available base plans
    api_response = api_instance.get_available_base_plans(account_id=account_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogApi->get_available_base_plans: %s\n" % e)

Parameters

Name	Type	Description	Notes
account_id	str		[optional]

Return type

list[PlanDetail]

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: application/json

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

get_catalog_json

list[Catalog] get_catalog_json(requested_date=requested_date, account_id=account_id)

Retrieve the catalog as JSON

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.CatalogApi(killbill.ApiClient(configuration))
requested_date = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
account_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str |  (optional)

try:
    # Retrieve the catalog as JSON
    api_response = api_instance.get_catalog_json(requested_date=requested_date, account_id=account_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogApi->get_catalog_json: %s\n" % e)

Parameters

Name	Type	Description	Notes
requested_date	datetime		[optional]
account_id	str		[optional]

Return type

list[Catalog]

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: application/json

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

get_catalog_versions

list[datetime] get_catalog_versions(account_id=account_id)

Retrieve a list of catalog versions

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.CatalogApi(killbill.ApiClient(configuration))
account_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str |  (optional)

try:
    # Retrieve a list of catalog versions
    api_response = api_instance.get_catalog_versions(account_id=account_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogApi->get_catalog_versions: %s\n" % e)

Parameters

Name	Type	Description	Notes
account_id	str		[optional]

Return type

list[datetime]

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: application/json

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

get_catalog_xml

str get_catalog_xml(requested_date=requested_date, account_id=account_id)

Retrieve the full catalog as XML

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.CatalogApi(killbill.ApiClient(configuration))
requested_date = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
account_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str |  (optional)

try:
    # Retrieve the full catalog as XML
    api_response = api_instance.get_catalog_xml(requested_date=requested_date, account_id=account_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogApi->get_catalog_xml: %s\n" % e)

Parameters

Name	Type	Description	Notes
requested_date	datetime		[optional]
account_id	str		[optional]

Return type

str

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: text/xml

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

get_phase_for_subscription_and_date

Phase get_phase_for_subscription_and_date(subscription_id=subscription_id, requested_date=requested_date)

Retrieve phase for a given subscription and date

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.CatalogApi(killbill.ApiClient(configuration))
subscription_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str |  (optional)
requested_date = '2013-10-20' # date |  (optional)

try:
    # Retrieve phase for a given subscription and date
    api_response = api_instance.get_phase_for_subscription_and_date(subscription_id=subscription_id, requested_date=requested_date)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogApi->get_phase_for_subscription_and_date: %s\n" % e)

Parameters

Name	Type	Description	Notes
subscription_id	str		[optional]
requested_date	date		[optional]

Return type

Phase

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: application/json

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

get_plan_for_subscription_and_date

Plan get_plan_for_subscription_and_date(subscription_id=subscription_id, requested_date=requested_date)

Retrieve plan for a given subscription and date

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.CatalogApi(killbill.ApiClient(configuration))
subscription_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str |  (optional)
requested_date = '2013-10-20' # date |  (optional)

try:
    # Retrieve plan for a given subscription and date
    api_response = api_instance.get_plan_for_subscription_and_date(subscription_id=subscription_id, requested_date=requested_date)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogApi->get_plan_for_subscription_and_date: %s\n" % e)

Parameters

Name	Type	Description	Notes
subscription_id	str		[optional]
requested_date	date		[optional]

Return type

Plan

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: application/json

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

get_price_list_for_subscription_and_date

PriceList get_price_list_for_subscription_and_date(subscription_id=subscription_id, requested_date=requested_date)

Retrieve priceList for a given subscription and date

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.CatalogApi(killbill.ApiClient(configuration))
subscription_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str |  (optional)
requested_date = '2013-10-20' # date |  (optional)

try:
    # Retrieve priceList for a given subscription and date
    api_response = api_instance.get_price_list_for_subscription_and_date(subscription_id=subscription_id, requested_date=requested_date)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogApi->get_price_list_for_subscription_and_date: %s\n" % e)

Parameters

Name	Type	Description	Notes
subscription_id	str		[optional]
requested_date	date		[optional]

Return type

PriceList

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: application/json

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

get_product_for_subscription_and_date

Product get_product_for_subscription_and_date(subscription_id=subscription_id, requested_date=requested_date)

Retrieve product for a given subscription and date

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.CatalogApi(killbill.ApiClient(configuration))
subscription_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str |  (optional)
requested_date = '2013-10-20' # date |  (optional)

try:
    # Retrieve product for a given subscription and date
    api_response = api_instance.get_product_for_subscription_and_date(subscription_id=subscription_id, requested_date=requested_date)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogApi->get_product_for_subscription_and_date: %s\n" % e)

Parameters

Name	Type	Description	Notes
subscription_id	str		[optional]
requested_date	date		[optional]

Return type

Product

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: application/json

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

upload_catalog_xml

str upload_catalog_xml(body, x_killbill_created_by, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)

Upload the full catalog as XML

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.CatalogApi(killbill.ApiClient(configuration))
body = 'body_example' # str | 
x_killbill_created_by = 'x_killbill_created_by_example' # str | 
x_killbill_reason = 'x_killbill_reason_example' # str |  (optional)
x_killbill_comment = 'x_killbill_comment_example' # str |  (optional)

try:
    # Upload the full catalog as XML
    api_response = api_instance.upload_catalog_xml(body, x_killbill_created_by, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CatalogApi->upload_catalog_xml: %s\n" % e)

Parameters

Name	Type	Notes
body	str
x_killbill_created_by	str
x_killbill_reason	str	[optional]
x_killbill_comment	str	[optional]

Return type

str

Authorization

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

HTTP request headers

Content-Type: text/xml
Accept: /

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

Files

CatalogApi.md

Latest commit

History

CatalogApi.md

File metadata and controls

killbill.CatalogApi

add_simple_plan

Example

Parameters

Return type

Authorization

HTTP request headers

delete_catalog

Example

Parameters

Return type

Authorization

HTTP request headers

get_available_addons

Example

Parameters

Return type

Authorization

HTTP request headers

get_available_base_plans

Example

Parameters

Return type

Authorization

HTTP request headers

get_catalog_json

Example

Parameters

Return type

Authorization

HTTP request headers

get_catalog_versions

Example

Parameters

Return type

Authorization

HTTP request headers

get_catalog_xml

Example

Parameters

Return type

Authorization

HTTP request headers

get_phase_for_subscription_and_date

Example

Parameters

Return type

Authorization

HTTP request headers

get_plan_for_subscription_and_date

Example

Parameters

Return type

Authorization

HTTP request headers

get_price_list_for_subscription_and_date

Example

Parameters

Return type

Authorization

HTTP request headers

get_product_for_subscription_and_date

Example

Parameters

Return type

Authorization

HTTP request headers

upload_catalog_xml

Example

Parameters

Return type

Authorization

HTTP request headers