https://github.com/killbill/killbill-client-python
Python client library for Kill Bill
https://github.com/killbill/killbill-client-python
billing killbill payments subscriptions
Last synced: 11 months ago
JSON representation
Python client library for Kill Bill
- Host: GitHub
- URL: https://github.com/killbill/killbill-client-python
- Owner: killbill
- Created: 2012-06-17T22:33:27.000Z (almost 14 years ago)
- Default Branch: master
- Last Pushed: 2023-02-17T16:50:16.000Z (over 3 years ago)
- Last Synced: 2025-06-27T23:19:18.169Z (12 months ago)
- Topics: billing, killbill, payments, subscriptions
- Language: Python
- Homepage: https://killbill.io
- Size: 859 KB
- Stars: 9
- Watchers: 6
- Forks: 20
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# killbill
Kill Bill is an open-source billing and payments platform
This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
- API version: 0.24.0
- Package version: 0.0.1-SNAPSHOT
- Build package: org.killbill.billing.codegen.languages.KillbillPythonGenerator
## Requirements.
Python 2.7 and 3.4+
## Installation & Usage
### pip install
If the python package is hosted on Github, you can install directly from Github
```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
Then import the package:
```python
import killbill
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import killbill
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
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
killbill.configuration.api_key['X-Killbill-ApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# killbill.configuration.api_key_prefix['X-Killbill-ApiKey'] = 'Bearer'
# Configure API key authorization: Killbill Api Secret
killbill.configuration.api_key['X-Killbill-ApiSecret'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# killbill.configuration.api_key_prefix['X-Killbill-ApiSecret'] = 'Bearer'
# Configure HTTP basic authorization: basicAuth
killbill.configuration.username = 'YOUR_USERNAME'
killbill.configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = killbill.AccountApi()
account_id = 'account_id_example' # Str |
body = killbill.BlockingState() # BlockingState |
created_by = 'x_killbill_created_by_example' # Str |
requested_date = '2013-10-20' # Date | (optional)
plugin_property = ['plugin_property_example'] # List[Str] | (optional)
reason = 'x_killbill_reason_example' # Str | (optional)
comment = 'x_killbill_comment_example' # Str | (optional)
try:
# Block an account
api_response = api_instance.add_account_blocking_state(account_id, body, created_by, requested_date=requested_date, plugin_property=plugin_property, reason=reason, comment=comment)
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->add_account_blocking_state: %s\n" % e)
```
## Calling custom plugin endpoints
```python
configuration = killbill.Configuration()
configuration.host = 'http://127.0.0.1:8080'
kb_client = killbill.ApiClient(configuration)
def request(url, method, params=None, body=None, profiling_data=None):
header_params = {}
header_params['X-Killbill-CreatedBy'] = 'admin'
header_params['X-Killbill-Reason'] = 'for testing'
header_params['X-Killbill-Comment'] = 'no comment'
header_params['X-Killbill-ApiKey'] = 'bob'
header_params['X-Killbill-ApiSecret'] = 'lazar'
header_params['X-Killbill-Profiling-Req'] = 'JAXRS'
header_params['Content-Type'] = 'application/json'
header_params['Authorization'] = 'Basic YWRtaW46cGFzc3dvcmQ='
body, status_code, headers = kb_client.call_api(url,
method,
query_params=params,
header_params=header_params,
body=body,
response_type='object')
if profiling_data is not None and 'X-Killbill-Profiling-Resp' in headers:
profiling_header = json.loads(headers['X-Killbill-Profiling-Resp'])
jaxrs_profiling_header = profiling_header['rawData'][0]
key = "%s:%s" % (method, url)
if not key in profiling_data:
profiling_data[key] = []
profiling_data[key].append(jaxrs_profiling_header['durationUsec'])
return body
```