Skip to content

Latest commit

 

History

History
255 lines (194 loc) · 9.4 KB

OverdueApi.md

File metadata and controls

255 lines (194 loc) · 9.4 KB
Raw

killbill.OverdueApi

All URIs are relative to /

Method HTTP request Description
get_overdue_config_json GET /1.0/kb/overdue Retrieve the overdue config as JSON
get_overdue_config_xml GET /1.0/kb/overdue/xml Retrieve the overdue config as XML
upload_overdue_config_json POST /1.0/kb/overdue Upload the full overdue config as JSON
upload_overdue_config_xml POST /1.0/kb/overdue/xml Upload the full overdue config as XML

get_overdue_config_json

Overdue get_overdue_config_json()

Retrieve the overdue config 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.OverdueApi(killbill.ApiClient(configuration))

try:
    # Retrieve the overdue config as JSON
    api_response = api_instance.get_overdue_config_json()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OverdueApi->get_overdue_config_json: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

Overdue

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_overdue_config_xml

str get_overdue_config_xml()

Retrieve the overdue config 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.OverdueApi(killbill.ApiClient(configuration))

try:
    # Retrieve the overdue config as XML
    api_response = api_instance.get_overdue_config_xml()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OverdueApi->get_overdue_config_xml: %s\n" % e)

Parameters

This endpoint does not need any parameter.

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]

upload_overdue_config_json

Overdue upload_overdue_config_json(body, x_killbill_created_by, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)

Upload the full overdue config 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.OverdueApi(killbill.ApiClient(configuration))
body = killbill.Overdue() # Overdue | 
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 overdue config as JSON
    api_response = api_instance.upload_overdue_config_json(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 OverdueApi->upload_overdue_config_json: %s\n" % e)

Parameters

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

Return type

Overdue

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]

upload_overdue_config_xml

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

Upload the full overdue config 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.OverdueApi(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 overdue config as XML
    api_response = api_instance.upload_overdue_config_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 OverdueApi->upload_overdue_config_xml: %s\n" % e)

Parameters

Name Type Description 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]