killbill.PaymentMethodApi

All URIs are relative to /

Method	HTTP request	Description
create_payment_method_custom_fields	POST /1.0/kb/paymentMethods/{paymentMethodId}/customFields	Add custom fields to payment method
delete_payment_method	DELETE /1.0/kb/paymentMethods/{paymentMethodId}	Delete a payment method
delete_payment_method_custom_fields	DELETE /1.0/kb/paymentMethods/{paymentMethodId}/customFields	Remove custom fields from payment method
get_payment_method	GET /1.0/kb/paymentMethods/{paymentMethodId}	Retrieve a payment method by id
get_payment_method_audit_logs_with_history	GET /1.0/kb/paymentMethods/{paymentMethodId}/auditLogsWithHistory	Retrieve payment method audit logs with history by id
get_payment_method_by_key	GET /1.0/kb/paymentMethods	Retrieve a payment method by external key
get_payment_method_custom_fields	GET /1.0/kb/paymentMethods/{paymentMethodId}/customFields	Retrieve payment method custom fields
get_payment_methods	GET /1.0/kb/paymentMethods/pagination	List payment methods
modify_payment_method_custom_fields	PUT /1.0/kb/paymentMethods/{paymentMethodId}/customFields	Modify custom fields to payment method
search_payment_methods	GET /1.0/kb/paymentMethods/search/{searchKey}	Search payment methods

create_payment_method_custom_fields

list[CustomField] create_payment_method_custom_fields(body, x_killbill_created_by, payment_method_id, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)

Add custom fields to payment method

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.PaymentMethodApi(killbill.ApiClient(configuration))
body = [killbill.CustomField()] # list[CustomField] | 
x_killbill_created_by = 'x_killbill_created_by_example' # str | 
payment_method_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 payment method
    api_response = api_instance.create_payment_method_custom_fields(body, x_killbill_created_by, payment_method_id, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentMethodApi->create_payment_method_custom_fields: %s\n" % e)

Parameters

Name	Type	Notes
body	list[CustomField]
x_killbill_created_by	str
payment_method_id	str
x_killbill_reason	str	[optional]
x_killbill_comment	str	[optional]

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

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

delete_payment_method

delete_payment_method(payment_method_id, x_killbill_created_by, delete_default_pm_with_auto_pay_off=delete_default_pm_with_auto_pay_off, force_default_pm_deletion=force_default_pm_deletion, plugin_property=plugin_property, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)

Delete a payment method

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.PaymentMethodApi(killbill.ApiClient(configuration))
payment_method_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 
x_killbill_created_by = 'x_killbill_created_by_example' # str | 
delete_default_pm_with_auto_pay_off = false # bool |  (optional) (default to false)
force_default_pm_deletion = 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:
    # Delete a payment method
    api_instance.delete_payment_method(payment_method_id, x_killbill_created_by, delete_default_pm_with_auto_pay_off=delete_default_pm_with_auto_pay_off, force_default_pm_deletion=force_default_pm_deletion, plugin_property=plugin_property, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)
except ApiException as e:
    print("Exception when calling PaymentMethodApi->delete_payment_method: %s\n" % e)

Parameters

Name	Type	Notes
payment_method_id	str
x_killbill_created_by	str
delete_default_pm_with_auto_pay_off	bool	[optional] [default to false]
force_default_pm_deletion	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]

delete_payment_method_custom_fields

delete_payment_method_custom_fields(payment_method_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 payment method

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.PaymentMethodApi(killbill.ApiClient(configuration))
payment_method_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 payment method
    api_instance.delete_payment_method_custom_fields(payment_method_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 PaymentMethodApi->delete_payment_method_custom_fields: %s\n" % e)

Parameters

Name	Type	Notes
payment_method_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]

get_payment_method

PaymentMethod get_payment_method(payment_method_id, included_deleted=included_deleted, with_plugin_info=with_plugin_info, plugin_property=plugin_property, audit=audit)

Retrieve a payment method 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.PaymentMethodApi(killbill.ApiClient(configuration))
payment_method_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 
included_deleted = false # bool |  (optional) (default to false)
with_plugin_info = false # bool |  (optional) (default to false)
plugin_property = ['plugin_property_example'] # list[str] |  (optional)
audit = 'NONE' # str |  (optional) (default to NONE)

try:
    # Retrieve a payment method by id
    api_response = api_instance.get_payment_method(payment_method_id, included_deleted=included_deleted, with_plugin_info=with_plugin_info, plugin_property=plugin_property, audit=audit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentMethodApi->get_payment_method: %s\n" % e)

Parameters

Name	Type	Notes
payment_method_id	str
included_deleted	bool	[optional] [default to false]
with_plugin_info	bool	[optional] [default to false]
plugin_property	list[str]	[optional]
audit	str	[optional] [default to NONE]

Return type

PaymentMethod

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_payment_method_audit_logs_with_history

list[AuditLog] get_payment_method_audit_logs_with_history(payment_method_id)

Retrieve payment method 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.PaymentMethodApi(killbill.ApiClient(configuration))
payment_method_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 

try:
    # Retrieve payment method audit logs with history by id
    api_response = api_instance.get_payment_method_audit_logs_with_history(payment_method_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentMethodApi->get_payment_method_audit_logs_with_history: %s\n" % e)

Parameters

Name	Type	Description	Notes
payment_method_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_payment_method_by_key

PaymentMethod get_payment_method_by_key(external_key, included_deleted=included_deleted, with_plugin_info=with_plugin_info, plugin_property=plugin_property, audit=audit)

Retrieve a payment method 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.PaymentMethodApi(killbill.ApiClient(configuration))
external_key = 'external_key_example' # str | 
included_deleted = false # bool |  (optional) (default to false)
with_plugin_info = false # bool |  (optional) (default to false)
plugin_property = ['plugin_property_example'] # list[str] |  (optional)
audit = 'NONE' # str |  (optional) (default to NONE)

try:
    # Retrieve a payment method by external key
    api_response = api_instance.get_payment_method_by_key(external_key, included_deleted=included_deleted, with_plugin_info=with_plugin_info, plugin_property=plugin_property, audit=audit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentMethodApi->get_payment_method_by_key: %s\n" % e)

Parameters

Name	Type	Notes
external_key	str
included_deleted	bool	[optional] [default to false]
with_plugin_info	bool	[optional] [default to false]
plugin_property	list[str]	[optional]
audit	str	[optional] [default to NONE]

Return type

PaymentMethod

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_payment_method_custom_fields

list[CustomField] get_payment_method_custom_fields(payment_method_id, audit=audit)

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

try:
    # Retrieve payment method custom fields
    api_response = api_instance.get_payment_method_custom_fields(payment_method_id, audit=audit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentMethodApi->get_payment_method_custom_fields: %s\n" % e)

Parameters

Name	Type	Description	Notes
payment_method_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_payment_methods

list[PaymentMethod] get_payment_methods(offset=offset, limit=limit, plugin_name=plugin_name, with_plugin_info=with_plugin_info, plugin_property=plugin_property, audit=audit)

List payment methods

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.PaymentMethodApi(killbill.ApiClient(configuration))
offset = 0 # int |  (optional) (default to 0)
limit = 100 # int |  (optional) (default to 100)
plugin_name = 'plugin_name_example' # str |  (optional)
with_plugin_info = false # bool |  (optional) (default to false)
plugin_property = ['plugin_property_example'] # list[str] |  (optional)
audit = 'NONE' # str |  (optional) (default to NONE)

try:
    # List payment methods
    api_response = api_instance.get_payment_methods(offset=offset, limit=limit, plugin_name=plugin_name, with_plugin_info=with_plugin_info, plugin_property=plugin_property, audit=audit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentMethodApi->get_payment_methods: %s\n" % e)

Parameters

Name	Type	Notes
offset	int	[optional] [default to 0]
limit	int	[optional] [default to 100]
plugin_name	str	[optional]
with_plugin_info	bool	[optional] [default to false]
plugin_property	list[str]	[optional]
audit	str	[optional] [default to NONE]

Return type

list[PaymentMethod]

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_payment_method_custom_fields

modify_payment_method_custom_fields(body, x_killbill_created_by, payment_method_id, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)

Modify custom fields to payment method

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.PaymentMethodApi(killbill.ApiClient(configuration))
body = [killbill.CustomField()] # list[CustomField] | 
x_killbill_created_by = 'x_killbill_created_by_example' # str | 
payment_method_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 payment method
    api_instance.modify_payment_method_custom_fields(body, x_killbill_created_by, payment_method_id, x_killbill_reason=x_killbill_reason, x_killbill_comment=x_killbill_comment)
except ApiException as e:
    print("Exception when calling PaymentMethodApi->modify_payment_method_custom_fields: %s\n" % e)

Parameters

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

search_payment_methods

list[PaymentMethod] search_payment_methods(search_key, offset=offset, limit=limit, plugin_name=plugin_name, with_plugin_info=with_plugin_info, plugin_property=plugin_property, audit=audit)

Search payment methods

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.PaymentMethodApi(killbill.ApiClient(configuration))
search_key = 'search_key_example' # str | 
offset = 0 # int |  (optional) (default to 0)
limit = 100 # int |  (optional) (default to 100)
plugin_name = 'plugin_name_example' # str |  (optional)
with_plugin_info = false # bool |  (optional) (default to false)
plugin_property = ['plugin_property_example'] # list[str] |  (optional)
audit = 'NONE' # str |  (optional) (default to NONE)

try:
    # Search payment methods
    api_response = api_instance.search_payment_methods(search_key, offset=offset, limit=limit, plugin_name=plugin_name, with_plugin_info=with_plugin_info, plugin_property=plugin_property, audit=audit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentMethodApi->search_payment_methods: %s\n" % e)

Parameters

Name	Type	Notes
search_key	str
offset	int	[optional] [default to 0]
limit	int	[optional] [default to 100]
plugin_name	str	[optional]
with_plugin_info	bool	[optional] [default to false]
plugin_property	list[str]	[optional]
audit	str	[optional] [default to NONE]

Return type

list[PaymentMethod]

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]

Files

PaymentMethodApi.md

Latest commit

History

PaymentMethodApi.md

File metadata and controls

killbill.PaymentMethodApi

create_payment_method_custom_fields

Example

Parameters

Return type

Authorization

HTTP request headers

delete_payment_method

Example

Parameters

Return type

Authorization

HTTP request headers

delete_payment_method_custom_fields

Example

Parameters

Return type

Authorization

HTTP request headers

get_payment_method

Example

Parameters

Return type

Authorization

HTTP request headers

get_payment_method_audit_logs_with_history

Example

Parameters

Return type

Authorization

HTTP request headers

get_payment_method_by_key

Example

Parameters

Return type

Authorization

HTTP request headers

get_payment_method_custom_fields

Example

Parameters

Return type

Authorization

HTTP request headers

get_payment_methods

Example

Parameters

Return type

Authorization

HTTP request headers

modify_payment_method_custom_fields

Example

Parameters

Return type

Authorization

HTTP request headers

search_payment_methods

Example

Parameters

Return type

Authorization

HTTP request headers