killbill.TagDefinitionApi

All URIs are relative to /

Method	HTTP request	Description
create_tag_definition	POST /1.0/kb/tagDefinitions	Create a tag definition
delete_tag_definition	DELETE /1.0/kb/tagDefinitions/{tagDefinitionId}	Delete a tag definition
get_tag_definition	GET /1.0/kb/tagDefinitions/{tagDefinitionId}	Retrieve a tag definition
get_tag_definition_audit_logs_with_history	GET /1.0/kb/tagDefinitions/{tagDefinitionId}/auditLogsWithHistory	Retrieve tag definition audit logs with history by id
get_tag_definitions	GET /1.0/kb/tagDefinitions	List tag definitions

create_tag_definition

TagDefinition create_tag_definition(body, x_killbill_created_by, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)

Create a tag definition

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.TagDefinitionApi(killbill.ApiClient(configuration))
body = killbill.TagDefinition() # TagDefinition | 
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:
    # Create a tag definition
    api_response = api_instance.create_tag_definition(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 TagDefinitionApi->create_tag_definition: %s\n" % e)

Parameters

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

Return type

TagDefinition

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_tag_definition

delete_tag_definition(tag_definition_id, x_killbill_created_by, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)

Delete a tag definition

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.TagDefinitionApi(killbill.ApiClient(configuration))
tag_definition_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # 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:
    # Delete a tag definition
    api_instance.delete_tag_definition(tag_definition_id, x_killbill_created_by, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)
except ApiException as e:
    print("Exception when calling TagDefinitionApi->delete_tag_definition: %s\n" % e)

Parameters

Name	Type	Notes
tag_definition_id	str
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_tag_definition

TagDefinition get_tag_definition(tag_definition_id, audit=audit)

Retrieve a tag definition

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

try:
    # Retrieve a tag definition
    api_response = api_instance.get_tag_definition(tag_definition_id, audit=audit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagDefinitionApi->get_tag_definition: %s\n" % e)

Parameters

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

Return type

TagDefinition

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_tag_definition_audit_logs_with_history

list[AuditLog] get_tag_definition_audit_logs_with_history(tag_definition_id)

Retrieve tag definition 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.TagDefinitionApi(killbill.ApiClient(configuration))
tag_definition_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 

try:
    # Retrieve tag definition audit logs with history by id
    api_response = api_instance.get_tag_definition_audit_logs_with_history(tag_definition_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagDefinitionApi->get_tag_definition_audit_logs_with_history: %s\n" % e)

Parameters

Name	Type	Description	Notes
tag_definition_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_tag_definitions

list[TagDefinition] get_tag_definitions(audit=audit)

List tag definitions

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

try:
    # List tag definitions
    api_response = api_instance.get_tag_definitions(audit=audit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagDefinitionApi->get_tag_definitions: %s\n" % e)

Parameters

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

Return type

list[TagDefinition]

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]

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

TagDefinitionApi.md

TagDefinitionApi.md

killbill.TagDefinitionApi

create_tag_definition

Example

Parameters

Return type

Authorization

HTTP request headers

delete_tag_definition

Example

Parameters

Return type

Authorization

HTTP request headers

get_tag_definition

Example

Parameters

Return type

Authorization

HTTP request headers

get_tag_definition_audit_logs_with_history

Example

Parameters

Return type

Authorization

HTTP request headers

get_tag_definitions

Example

Parameters

Return type

Authorization

HTTP request headers

Files

TagDefinitionApi.md

Latest commit

History

TagDefinitionApi.md

File metadata and controls

killbill.TagDefinitionApi

create_tag_definition

Example

Parameters

Return type

Authorization

HTTP request headers

delete_tag_definition

Example

Parameters

Return type

Authorization

HTTP request headers

get_tag_definition

Example

Parameters

Return type

Authorization

HTTP request headers

get_tag_definition_audit_logs_with_history

Example

Parameters

Return type

Authorization

HTTP request headers

get_tag_definitions

Example

Parameters

Return type

Authorization

HTTP request headers