killbill.SubscriptionApi

All URIs are relative to /

Method	HTTP request	Description
add_subscription_blocking_state	POST /1.0/kb/subscriptions/{subscriptionId}/block	Block a subscription
cancel_subscription_plan	DELETE /1.0/kb/subscriptions/{subscriptionId}	Cancel an entitlement plan
change_subscription_plan	PUT /1.0/kb/subscriptions/{subscriptionId}	Change entitlement plan
create_subscription	POST /1.0/kb/subscriptions	Create an subscription
create_subscription_custom_fields	POST /1.0/kb/subscriptions/{subscriptionId}/customFields	Add custom fields to subscription
create_subscription_tags	POST /1.0/kb/subscriptions/{subscriptionId}/tags
create_subscription_with_add_ons	POST /1.0/kb/subscriptions/createSubscriptionWithAddOns	Create an entitlement with addOn products
create_subscriptions_with_add_ons	POST /1.0/kb/subscriptions/createSubscriptionsWithAddOns	Create multiple entitlements with addOn products
delete_subscription_custom_fields	DELETE /1.0/kb/subscriptions/{subscriptionId}/customFields	Remove custom fields from subscription
delete_subscription_tags	DELETE /1.0/kb/subscriptions/{subscriptionId}/tags	Remove tags from subscription
get_subscription	GET /1.0/kb/subscriptions/{subscriptionId}	Retrieve a subscription by id
get_subscription_audit_logs_with_history	GET /1.0/kb/subscriptions/{subscriptionId}/auditLogsWithHistory	Retrieve subscription audit logs with history by id
get_subscription_by_key	GET /1.0/kb/subscriptions	Retrieve a subscription by external key
get_subscription_custom_fields	GET /1.0/kb/subscriptions/{subscriptionId}/customFields	Retrieve subscription custom fields
get_subscription_event_audit_logs_with_history	GET /1.0/kb/subscriptions/events/{eventId}/auditLogsWithHistory	Retrieve subscription event audit logs with history by id
get_subscription_tags	GET /1.0/kb/subscriptions/{subscriptionId}/tags	Retrieve subscription tags
modify_subscription_custom_fields	PUT /1.0/kb/subscriptions/{subscriptionId}/customFields	Modify custom fields to subscription
uncancel_subscription_plan	PUT /1.0/kb/subscriptions/{subscriptionId}/uncancel	Un-cancel an entitlement
undo_change_subscription_plan	PUT /1.0/kb/subscriptions/{subscriptionId}/undoChangePlan	Undo a pending change plan on an entitlement
update_subscription_bcd	PUT /1.0/kb/subscriptions/{subscriptionId}/bcd	Update the BCD associated to a subscription

add_subscription_blocking_state

list[BlockingState] add_subscription_blocking_state(body, x_killbill_created_by, subscription_id, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment, requested_date=requested_date, plugin_property=plugin_property)

Block a subscription

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.SubscriptionApi(killbill.ApiClient(configuration))
body = killbill.BlockingState() # BlockingState | 
x_killbill_created_by = 'x_killbill_created_by_example' # str | 
subscription_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)
requested_date = '2013-10-20' # date |  (optional)
plugin_property = ['plugin_property_example'] # list[str] |  (optional)

try:
    # Block a subscription
    api_response = api_instance.add_subscription_blocking_state(body, x_killbill_created_by, subscription_id, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment, requested_date=requested_date, plugin_property=plugin_property)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubscriptionApi->add_subscription_blocking_state: %s\n" % e)

Parameters

Name	Type	Notes
body	BlockingState
x_killbill_created_by	str
subscription_id	str
x_killbill_reason	str	[optional]
x_killbill_comment	str	[optional]
requested_date	date	[optional]
plugin_property	list[str]	[optional]

Return type

list[BlockingState]

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

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

cancel_subscription_plan

cancel_subscription_plan(subscription_id, x_killbill_created_by, requested_date=requested_date, call_completion=call_completion, call_timeout_sec=call_timeout_sec, entitlement_policy=entitlement_policy, billing_policy=billing_policy, use_requested_date_for_billing=use_requested_date_for_billing, plugin_property=plugin_property, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)

Cancel an entitlement plan

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.SubscriptionApi(killbill.ApiClient(configuration))
subscription_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 
x_killbill_created_by = 'x_killbill_created_by_example' # str | 
requested_date = '2013-10-20' # date |  (optional)
call_completion = false # bool |  (optional) (default to false)
call_timeout_sec = 5 # int |  (optional) (default to 5)
entitlement_policy = 'entitlement_policy_example' # str |  (optional)
billing_policy = 'billing_policy_example' # str |  (optional)
use_requested_date_for_billing = false # bool |  (optional) (default to false)
plugin_property = ['plugin_property_example'] # list[str] |  (optional)
x_killbill_reason = 'x_killbill_reason_example' # str |  (optional)
x_killbill_comment = 'x_killbill_comment_example' # str |  (optional)

try:
    # Cancel an entitlement plan
    api_instance.cancel_subscription_plan(subscription_id, x_killbill_created_by, requested_date=requested_date, call_completion=call_completion, call_timeout_sec=call_timeout_sec, entitlement_policy=entitlement_policy, billing_policy=billing_policy, use_requested_date_for_billing=use_requested_date_for_billing, plugin_property=plugin_property, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)
except ApiException as e:
    print("Exception when calling SubscriptionApi->cancel_subscription_plan: %s\n" % e)

Parameters

Name	Type	Notes
subscription_id	str
x_killbill_created_by	str
requested_date	date	[optional]
call_completion	bool	[optional] [default to false]
call_timeout_sec	int	[optional] [default to 5]
entitlement_policy	str	[optional]
billing_policy	str	[optional]
use_requested_date_for_billing	bool	[optional] [default to false]
plugin_property	list[str]	[optional]
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]

change_subscription_plan

change_subscription_plan(body, x_killbill_created_by, subscription_id, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment, requested_date=requested_date, call_completion=call_completion, call_timeout_sec=call_timeout_sec, billing_policy=billing_policy, plugin_property=plugin_property)

Change entitlement plan

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.SubscriptionApi(killbill.ApiClient(configuration))
body = killbill.Subscription() # Subscription | 
x_killbill_created_by = 'x_killbill_created_by_example' # str | 
subscription_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)
requested_date = '2013-10-20' # date |  (optional)
call_completion = false # bool |  (optional) (default to false)
call_timeout_sec = 3 # int |  (optional) (default to 3)
billing_policy = 'billing_policy_example' # str |  (optional)
plugin_property = ['plugin_property_example'] # list[str] |  (optional)

try:
    # Change entitlement plan
    api_instance.change_subscription_plan(body, x_killbill_created_by, subscription_id, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment, requested_date=requested_date, call_completion=call_completion, call_timeout_sec=call_timeout_sec, billing_policy=billing_policy, plugin_property=plugin_property)
except ApiException as e:
    print("Exception when calling SubscriptionApi->change_subscription_plan: %s\n" % e)

Parameters

Name	Type	Notes
body	Subscription
x_killbill_created_by	str
subscription_id	str
x_killbill_reason	str	[optional]
x_killbill_comment	str	[optional]
requested_date	date	[optional]
call_completion	bool	[optional] [default to false]
call_timeout_sec	int	[optional] [default to 3]
billing_policy	str	[optional]
plugin_property	list[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]

create_subscription

Subscription create_subscription(body, x_killbill_created_by, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment, entitlement_date=entitlement_date, billing_date=billing_date, rename_key_if_exists_and_unused=rename_key_if_exists_and_unused, migrated=migrated, skip_response=skip_response, call_completion=call_completion, call_timeout_sec=call_timeout_sec, plugin_property=plugin_property)

Create an subscription

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.SubscriptionApi(killbill.ApiClient(configuration))
body = killbill.Subscription() # Subscription | 
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)
entitlement_date = '2013-10-20' # date |  (optional)
billing_date = '2013-10-20' # date |  (optional)
rename_key_if_exists_and_unused = true # bool |  (optional) (default to true)
migrated = false # bool |  (optional) (default to false)
skip_response = false # bool |  (optional) (default to false)
call_completion = false # bool |  (optional) (default to false)
call_timeout_sec = 3 # int |  (optional) (default to 3)
plugin_property = ['plugin_property_example'] # list[str] |  (optional)

try:
    # Create an subscription
    api_response = api_instance.create_subscription(body, x_killbill_created_by, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment, entitlement_date=entitlement_date, billing_date=billing_date, rename_key_if_exists_and_unused=rename_key_if_exists_and_unused, migrated=migrated, skip_response=skip_response, call_completion=call_completion, call_timeout_sec=call_timeout_sec, plugin_property=plugin_property)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubscriptionApi->create_subscription: %s\n" % e)

Parameters

Name	Type	Notes
body	Subscription
x_killbill_created_by	str
x_killbill_reason	str	[optional]
x_killbill_comment	str	[optional]
entitlement_date	date	[optional]
billing_date	date	[optional]
rename_key_if_exists_and_unused	bool	[optional] [default to true]
migrated	bool	[optional] [default to false]
skip_response	bool	[optional] [default to false]
call_completion	bool	[optional] [default to false]
call_timeout_sec	int	[optional] [default to 3]
plugin_property	list[str]	[optional]

Return type

Subscription

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]

create_subscription_custom_fields

create_subscription_custom_fields(body, x_killbill_created_by, subscription_id, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)

Add custom fields to subscription

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.SubscriptionApi(killbill.ApiClient(configuration))
body = [killbill.CustomField()] # list[CustomField] | 
x_killbill_created_by = 'x_killbill_created_by_example' # str | 
subscription_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:
    # Add custom fields to subscription
    api_instance.create_subscription_custom_fields(body, x_killbill_created_by, subscription_id, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)
except ApiException as e:
    print("Exception when calling SubscriptionApi->create_subscription_custom_fields: %s\n" % e)

Parameters

Name	Type	Notes
body	list[CustomField]
x_killbill_created_by	str
subscription_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]

create_subscription_tags

create_subscription_tags(body, x_killbill_created_by, subscription_id, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)

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.SubscriptionApi(killbill.ApiClient(configuration))
body = ['body_example'] # list[str] | 
x_killbill_created_by = 'x_killbill_created_by_example' # str | 
subscription_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:
    api_instance.create_subscription_tags(body, x_killbill_created_by, subscription_id, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)
except ApiException as e:
    print("Exception when calling SubscriptionApi->create_subscription_tags: %s\n" % e)

Parameters

Name	Type	Notes
body	list[str]
x_killbill_created_by	str
subscription_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]

create_subscription_with_add_ons

Bundle create_subscription_with_add_ons(body, x_killbill_created_by, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment, entitlement_date=entitlement_date, billing_date=billing_date, migrated=migrated, skip_response=skip_response, rename_key_if_exists_and_unused=rename_key_if_exists_and_unused, call_completion=call_completion, call_timeout_sec=call_timeout_sec, plugin_property=plugin_property)

Create an entitlement with addOn products

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.SubscriptionApi(killbill.ApiClient(configuration))
body = [killbill.Subscription()] # list[Subscription] | 
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)
entitlement_date = '2013-10-20' # date |  (optional)
billing_date = '2013-10-20' # date |  (optional)
migrated = false # bool |  (optional) (default to false)
skip_response = false # bool |  (optional) (default to false)
rename_key_if_exists_and_unused = true # bool |  (optional) (default to true)
call_completion = false # bool |  (optional) (default to false)
call_timeout_sec = 3 # int |  (optional) (default to 3)
plugin_property = ['plugin_property_example'] # list[str] |  (optional)

try:
    # Create an entitlement with addOn products
    api_response = api_instance.create_subscription_with_add_ons(body, x_killbill_created_by, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment, entitlement_date=entitlement_date, billing_date=billing_date, migrated=migrated, skip_response=skip_response, rename_key_if_exists_and_unused=rename_key_if_exists_and_unused, call_completion=call_completion, call_timeout_sec=call_timeout_sec, plugin_property=plugin_property)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubscriptionApi->create_subscription_with_add_ons: %s\n" % e)

Parameters

Name	Type	Notes
body	list[Subscription]
x_killbill_created_by	str
x_killbill_reason	str	[optional]
x_killbill_comment	str	[optional]
entitlement_date	date	[optional]
billing_date	date	[optional]
migrated	bool	[optional] [default to false]
skip_response	bool	[optional] [default to false]
rename_key_if_exists_and_unused	bool	[optional] [default to true]
call_completion	bool	[optional] [default to false]
call_timeout_sec	int	[optional] [default to 3]
plugin_property	list[str]	[optional]

Return type

Bundle

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]

create_subscriptions_with_add_ons

list[Bundle] create_subscriptions_with_add_ons(body, x_killbill_created_by, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment, entitlement_date=entitlement_date, billing_date=billing_date, rename_key_if_exists_and_unused=rename_key_if_exists_and_unused, migrated=migrated, skip_response=skip_response, call_completion=call_completion, call_timeout_sec=call_timeout_sec, plugin_property=plugin_property)

Create multiple entitlements with addOn products

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.SubscriptionApi(killbill.ApiClient(configuration))
body = [killbill.BulkSubscriptionsBundle()] # list[BulkSubscriptionsBundle] | 
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)
entitlement_date = '2013-10-20' # date |  (optional)
billing_date = '2013-10-20' # date |  (optional)
rename_key_if_exists_and_unused = true # bool |  (optional) (default to true)
migrated = false # bool |  (optional) (default to false)
skip_response = false # bool |  (optional) (default to false)
call_completion = false # bool |  (optional) (default to false)
call_timeout_sec = 3 # int |  (optional) (default to 3)
plugin_property = ['plugin_property_example'] # list[str] |  (optional)

try:
    # Create multiple entitlements with addOn products
    api_response = api_instance.create_subscriptions_with_add_ons(body, x_killbill_created_by, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment, entitlement_date=entitlement_date, billing_date=billing_date, rename_key_if_exists_and_unused=rename_key_if_exists_and_unused, migrated=migrated, skip_response=skip_response, call_completion=call_completion, call_timeout_sec=call_timeout_sec, plugin_property=plugin_property)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubscriptionApi->create_subscriptions_with_add_ons: %s\n" % e)

Parameters

Name	Type	Notes
body	list[BulkSubscriptionsBundle]
x_killbill_created_by	str
x_killbill_reason	str	[optional]
x_killbill_comment	str	[optional]
entitlement_date	date	[optional]
billing_date	date	[optional]
rename_key_if_exists_and_unused	bool	[optional] [default to true]
migrated	bool	[optional] [default to false]
skip_response	bool	[optional] [default to false]
call_completion	bool	[optional] [default to false]
call_timeout_sec	int	[optional] [default to 3]
plugin_property	list[str]	[optional]

Return type

list[Bundle]

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_subscription_custom_fields

delete_subscription_custom_fields(subscription_id, x_killbill_created_by, custom_field=custom_field, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)

Remove custom fields from subscription

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.SubscriptionApi(killbill.ApiClient(configuration))
subscription_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 
x_killbill_created_by = 'x_killbill_created_by_example' # str | 
custom_field = ['custom_field_example'] # list[str] |  (optional)
x_killbill_reason = 'x_killbill_reason_example' # str |  (optional)
x_killbill_comment = 'x_killbill_comment_example' # str |  (optional)

try:
    # Remove custom fields from subscription
    api_instance.delete_subscription_custom_fields(subscription_id, x_killbill_created_by, custom_field=custom_field, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)
except ApiException as e:
    print("Exception when calling SubscriptionApi->delete_subscription_custom_fields: %s\n" % e)

Parameters

Name	Type	Notes
subscription_id	str
x_killbill_created_by	str
custom_field	list[str]	[optional]
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]

delete_subscription_tags

delete_subscription_tags(subscription_id, x_killbill_created_by, tag_def=tag_def, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)

Remove tags from subscription

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.SubscriptionApi(killbill.ApiClient(configuration))
subscription_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 
x_killbill_created_by = 'x_killbill_created_by_example' # str | 
tag_def = ['tag_def_example'] # list[str] |  (optional)
x_killbill_reason = 'x_killbill_reason_example' # str |  (optional)
x_killbill_comment = 'x_killbill_comment_example' # str |  (optional)

try:
    # Remove tags from subscription
    api_instance.delete_subscription_tags(subscription_id, x_killbill_created_by, tag_def=tag_def, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)
except ApiException as e:
    print("Exception when calling SubscriptionApi->delete_subscription_tags: %s\n" % e)

Parameters

Name	Type	Notes
subscription_id	str
x_killbill_created_by	str
tag_def	list[str]	[optional]
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_subscription

Subscription get_subscription(subscription_id, audit=audit)

Retrieve a subscription by id

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.SubscriptionApi(killbill.ApiClient(configuration))
subscription_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 
audit = 'NONE' # str |  (optional) (default to NONE)

try:
    # Retrieve a subscription by id
    api_response = api_instance.get_subscription(subscription_id, audit=audit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubscriptionApi->get_subscription: %s\n" % e)

Parameters

Name	Type	Description	Notes
subscription_id	str
audit	str		[optional] [default to NONE]

Return type

Subscription

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_subscription_audit_logs_with_history

list[AuditLog] get_subscription_audit_logs_with_history(subscription_id)

Retrieve subscription audit logs with history by id

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

try:
    # Retrieve subscription audit logs with history by id
    api_response = api_instance.get_subscription_audit_logs_with_history(subscription_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubscriptionApi->get_subscription_audit_logs_with_history: %s\n" % e)

Parameters

Name	Type	Description	Notes
subscription_id	str

Return type

list[AuditLog]

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_subscription_by_key

Subscription get_subscription_by_key(external_key, audit=audit)

Retrieve a subscription by external key

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.SubscriptionApi(killbill.ApiClient(configuration))
external_key = 'external_key_example' # str | 
audit = 'NONE' # str |  (optional) (default to NONE)

try:
    # Retrieve a subscription by external key
    api_response = api_instance.get_subscription_by_key(external_key, audit=audit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubscriptionApi->get_subscription_by_key: %s\n" % e)

Parameters

Name	Type	Description	Notes
external_key	str
audit	str		[optional] [default to NONE]

Return type

Subscription

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_subscription_custom_fields

list[CustomField] get_subscription_custom_fields(subscription_id, audit=audit)

Retrieve subscription custom fields

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.SubscriptionApi(killbill.ApiClient(configuration))
subscription_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 
audit = 'NONE' # str |  (optional) (default to NONE)

try:
    # Retrieve subscription custom fields
    api_response = api_instance.get_subscription_custom_fields(subscription_id, audit=audit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubscriptionApi->get_subscription_custom_fields: %s\n" % e)

Parameters

Name	Type	Description	Notes
subscription_id	str
audit	str		[optional] [default to NONE]

Return type

list[CustomField]

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_subscription_event_audit_logs_with_history

list[AuditLog] get_subscription_event_audit_logs_with_history(event_id)

Retrieve subscription event audit logs with history by id

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

try:
    # Retrieve subscription event audit logs with history by id
    api_response = api_instance.get_subscription_event_audit_logs_with_history(event_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubscriptionApi->get_subscription_event_audit_logs_with_history: %s\n" % e)

Parameters

Name	Type	Description	Notes
event_id	str

Return type

list[AuditLog]

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_subscription_tags

list[Tag] get_subscription_tags(subscription_id, included_deleted=included_deleted, audit=audit)

Retrieve subscription tags

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.SubscriptionApi(killbill.ApiClient(configuration))
subscription_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 
included_deleted = false # bool |  (optional) (default to false)
audit = 'NONE' # str |  (optional) (default to NONE)

try:
    # Retrieve subscription tags
    api_response = api_instance.get_subscription_tags(subscription_id, included_deleted=included_deleted, audit=audit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubscriptionApi->get_subscription_tags: %s\n" % e)

Parameters

Name	Type	Notes
subscription_id	str
included_deleted	bool	[optional] [default to false]
audit	str	[optional] [default to NONE]

Return type

list[Tag]

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]

modify_subscription_custom_fields

modify_subscription_custom_fields(body, x_killbill_created_by, subscription_id, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)

Modify custom fields to subscription

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.SubscriptionApi(killbill.ApiClient(configuration))
body = [killbill.CustomField()] # list[CustomField] | 
x_killbill_created_by = 'x_killbill_created_by_example' # str | 
subscription_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:
    # Modify custom fields to subscription
    api_instance.modify_subscription_custom_fields(body, x_killbill_created_by, subscription_id, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)
except ApiException as e:
    print("Exception when calling SubscriptionApi->modify_subscription_custom_fields: %s\n" % e)

Parameters

Name	Type	Notes
body	list[CustomField]
x_killbill_created_by	str
subscription_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]

uncancel_subscription_plan

uncancel_subscription_plan(subscription_id, x_killbill_created_by, plugin_property=plugin_property, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)

Un-cancel an entitlement

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.SubscriptionApi(killbill.ApiClient(configuration))
subscription_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 
x_killbill_created_by = 'x_killbill_created_by_example' # str | 
plugin_property = ['plugin_property_example'] # list[str] |  (optional)
x_killbill_reason = 'x_killbill_reason_example' # str |  (optional)
x_killbill_comment = 'x_killbill_comment_example' # str |  (optional)

try:
    # Un-cancel an entitlement
    api_instance.uncancel_subscription_plan(subscription_id, x_killbill_created_by, plugin_property=plugin_property, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)
except ApiException as e:
    print("Exception when calling SubscriptionApi->uncancel_subscription_plan: %s\n" % e)

Parameters

Name	Type	Notes
subscription_id	str
x_killbill_created_by	str
plugin_property	list[str]	[optional]
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]

undo_change_subscription_plan

undo_change_subscription_plan(subscription_id, x_killbill_created_by, plugin_property=plugin_property, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)

Undo a pending change plan on an entitlement

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.SubscriptionApi(killbill.ApiClient(configuration))
subscription_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 
x_killbill_created_by = 'x_killbill_created_by_example' # str | 
plugin_property = ['plugin_property_example'] # list[str] |  (optional)
x_killbill_reason = 'x_killbill_reason_example' # str |  (optional)
x_killbill_comment = 'x_killbill_comment_example' # str |  (optional)

try:
    # Undo a pending change plan on an entitlement
    api_instance.undo_change_subscription_plan(subscription_id, x_killbill_created_by, plugin_property=plugin_property, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)
except ApiException as e:
    print("Exception when calling SubscriptionApi->undo_change_subscription_plan: %s\n" % e)

Parameters

Name	Type	Notes
subscription_id	str
x_killbill_created_by	str
plugin_property	list[str]	[optional]
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_subscription_bcd

update_subscription_bcd(body, x_killbill_created_by, subscription_id, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment, effective_from_date=effective_from_date, force_new_bcd_with_past_effective_date=force_new_bcd_with_past_effective_date)

Update the BCD associated to a subscription

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.SubscriptionApi(killbill.ApiClient(configuration))
body = killbill.Subscription() # Subscription | 
x_killbill_created_by = 'x_killbill_created_by_example' # str | 
subscription_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)
effective_from_date = '2013-10-20' # date |  (optional)
force_new_bcd_with_past_effective_date = false # bool |  (optional) (default to false)

try:
    # Update the BCD associated to a subscription
    api_instance.update_subscription_bcd(body, x_killbill_created_by, subscription_id, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment, effective_from_date=effective_from_date, force_new_bcd_with_past_effective_date=force_new_bcd_with_past_effective_date)
except ApiException as e:
    print("Exception when calling SubscriptionApi->update_subscription_bcd: %s\n" % e)

Parameters

Name	Type	Notes
body	Subscription
x_killbill_created_by	str
subscription_id	str
x_killbill_reason	str	[optional]
x_killbill_comment	str	[optional]
effective_from_date	date	[optional]
force_new_bcd_with_past_effective_date	bool	[optional] [default to false]

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

SubscriptionApi.md

Latest commit

History

SubscriptionApi.md

File metadata and controls

killbill.SubscriptionApi

add_subscription_blocking_state

Example

Parameters

Return type

Authorization

HTTP request headers

cancel_subscription_plan

Example

Parameters

Return type

Authorization

HTTP request headers

change_subscription_plan

Example

Parameters

Return type

Authorization

HTTP request headers

create_subscription

Example

Parameters

Return type

Authorization

HTTP request headers

create_subscription_custom_fields

Example

Parameters

Return type

Authorization

HTTP request headers

create_subscription_tags

Example

Parameters

Return type

Authorization

HTTP request headers

create_subscription_with_add_ons

Example

Parameters

Return type

Authorization

HTTP request headers

create_subscriptions_with_add_ons

Example

Parameters

Return type

Authorization

HTTP request headers

delete_subscription_custom_fields

Example

Parameters

Return type

Authorization

HTTP request headers

delete_subscription_tags

Example

Parameters

Return type

Authorization

HTTP request headers

get_subscription

Example

Parameters

Return type

Authorization

HTTP request headers

get_subscription_audit_logs_with_history

Example

Parameters

Return type

Authorization

HTTP request headers

get_subscription_by_key