All URIs are relative to /
Method | HTTP request | Description |
---|---|---|
addBundleBlockingState | POST /1.0/kb/bundles/{bundleId}/block | Block a bundle |
createBundleCustomFields | POST /1.0/kb/bundles/{bundleId}/customFields | Add custom fields to bundle |
createBundleTags | POST /1.0/kb/bundles/{bundleId}/tags | Add tags to bundle |
deleteBundleCustomFields | DELETE /1.0/kb/bundles/{bundleId}/customFields | Remove custom fields from bundle |
deleteBundleTags | DELETE /1.0/kb/bundles/{bundleId}/tags | Remove tags from bundle |
getBundle | GET /1.0/kb/bundles/{bundleId} | Retrieve a bundle by id |
getBundleAuditLogsWithHistory | GET /1.0/kb/bundles/{bundleId}/auditLogsWithHistory | Retrieve bundle audit logs with history by id |
getBundleByKey | GET /1.0/kb/bundles | Retrieve a bundle by external key |
getBundleCustomFields | GET /1.0/kb/bundles/{bundleId}/customFields | Retrieve bundle custom fields |
getBundleTags | GET /1.0/kb/bundles/{bundleId}/tags | Retrieve bundle tags |
getBundles | GET /1.0/kb/bundles/pagination | List bundles |
modifyBundleCustomFields | PUT /1.0/kb/bundles/{bundleId}/customFields | Modify custom fields to bundle |
pauseBundle | PUT /1.0/kb/bundles/{bundleId}/pause | Pause a bundle |
renameExternalKey | PUT /1.0/kb/bundles/{bundleId}/renameKey | Update a bundle externalKey |
resumeBundle | PUT /1.0/kb/bundles/{bundleId}/resume | Resume a bundle |
searchBundles | GET /1.0/kb/bundles/search/{searchKey} | Search bundles |
transferBundle | POST /1.0/kb/bundles/{bundleId} | Transfer a bundle to another account |
\Killbill\Client\Swagger\Model\BlockingState[] addBundleBlockingState($body, $xKillbillCreatedBy, $bundleId, $xKillbillReason, $xKillbillComment, $requestedDate, $pluginProperty)
Block a bundle
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Killbill Api Key
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiKey', 'Bearer');// Configure API key authorization: Killbill Api Secret
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiSecret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiSecret', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new Killbill\Client\Swagger\Api\BundleApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$body = new \Killbill\Client\Swagger\Model\BlockingState(); // \Killbill\Client\Swagger\Model\BlockingState |
$xKillbillCreatedBy = "xKillbillCreatedBy_example"; // string |
$bundleId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string |
$xKillbillReason = "xKillbillReason_example"; // string |
$xKillbillComment = "xKillbillComment_example"; // string |
$requestedDate = new \DateTime("2013-10-20"); // \DateTime |
$pluginProperty = array("pluginProperty_example"); // string[] |
try {
$result = $apiInstance->addBundleBlockingState($body, $xKillbillCreatedBy, $bundleId, $xKillbillReason, $xKillbillComment, $requestedDate, $pluginProperty);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BundleApi->addBundleBlockingState: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Killbill\Client\Swagger\Model\BlockingState | ||
xKillbillCreatedBy | string | ||
bundleId | string | ||
xKillbillReason | string | [optional] | |
xKillbillComment | string | [optional] | |
requestedDate | \DateTime | [optional] | |
pluginProperty | string[] | [optional] |
\Killbill\Client\Swagger\Model\BlockingState[]
[Killbill Api Key](../../README.md#Killbill Api Key), [Killbill Api Secret](../../README.md#Killbill Api Secret), basicAuth
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Killbill\Client\Swagger\Model\CustomField[] createBundleCustomFields($body, $xKillbillCreatedBy, $bundleId, $xKillbillReason, $xKillbillComment)
Add custom fields to bundle
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Killbill Api Key
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiKey', 'Bearer');// Configure API key authorization: Killbill Api Secret
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiSecret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiSecret', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new Killbill\Client\Swagger\Api\BundleApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$body = array(new \Killbill\Client\Swagger\Model\CustomField()); // \Killbill\Client\Swagger\Model\CustomField[] |
$xKillbillCreatedBy = "xKillbillCreatedBy_example"; // string |
$bundleId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string |
$xKillbillReason = "xKillbillReason_example"; // string |
$xKillbillComment = "xKillbillComment_example"; // string |
try {
$result = $apiInstance->createBundleCustomFields($body, $xKillbillCreatedBy, $bundleId, $xKillbillReason, $xKillbillComment);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BundleApi->createBundleCustomFields: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Killbill\Client\Swagger\Model\CustomField[] | ||
xKillbillCreatedBy | string | ||
bundleId | string | ||
xKillbillReason | string | [optional] | |
xKillbillComment | string | [optional] |
\Killbill\Client\Swagger\Model\CustomField[]
[Killbill Api Key](../../README.md#Killbill Api Key), [Killbill Api Secret](../../README.md#Killbill Api Secret), basicAuth
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Killbill\Client\Swagger\Model\Tag[] createBundleTags($body, $xKillbillCreatedBy, $bundleId, $xKillbillReason, $xKillbillComment)
Add tags to bundle
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Killbill Api Key
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiKey', 'Bearer');// Configure API key authorization: Killbill Api Secret
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiSecret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiSecret', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new Killbill\Client\Swagger\Api\BundleApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$body = array("body_example"); // string[] |
$xKillbillCreatedBy = "xKillbillCreatedBy_example"; // string |
$bundleId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string |
$xKillbillReason = "xKillbillReason_example"; // string |
$xKillbillComment = "xKillbillComment_example"; // string |
try {
$result = $apiInstance->createBundleTags($body, $xKillbillCreatedBy, $bundleId, $xKillbillReason, $xKillbillComment);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BundleApi->createBundleTags: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | string[] | ||
xKillbillCreatedBy | string | ||
bundleId | string | ||
xKillbillReason | string | [optional] | |
xKillbillComment | string | [optional] |
\Killbill\Client\Swagger\Model\Tag[]
[Killbill Api Key](../../README.md#Killbill Api Key), [Killbill Api Secret](../../README.md#Killbill Api Secret), basicAuth
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteBundleCustomFields($bundleId, $xKillbillCreatedBy, $customField, $xKillbillReason, $xKillbillComment)
Remove custom fields from bundle
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Killbill Api Key
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiKey', 'Bearer');// Configure API key authorization: Killbill Api Secret
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiSecret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiSecret', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new Killbill\Client\Swagger\Api\BundleApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$bundleId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string |
$xKillbillCreatedBy = "xKillbillCreatedBy_example"; // string |
$customField = array("customField_example"); // string[] |
$xKillbillReason = "xKillbillReason_example"; // string |
$xKillbillComment = "xKillbillComment_example"; // string |
try {
$apiInstance->deleteBundleCustomFields($bundleId, $xKillbillCreatedBy, $customField, $xKillbillReason, $xKillbillComment);
} catch (Exception $e) {
echo 'Exception when calling BundleApi->deleteBundleCustomFields: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
bundleId | string | ||
xKillbillCreatedBy | string | ||
customField | string[] | [optional] | |
xKillbillReason | string | [optional] | |
xKillbillComment | string | [optional] |
void (empty response body)
[Killbill Api Key](../../README.md#Killbill Api Key), [Killbill Api Secret](../../README.md#Killbill Api Secret), basicAuth
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteBundleTags($bundleId, $xKillbillCreatedBy, $tagDef, $xKillbillReason, $xKillbillComment)
Remove tags from bundle
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Killbill Api Key
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiKey', 'Bearer');// Configure API key authorization: Killbill Api Secret
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiSecret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiSecret', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new Killbill\Client\Swagger\Api\BundleApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$bundleId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string |
$xKillbillCreatedBy = "xKillbillCreatedBy_example"; // string |
$tagDef = array("tagDef_example"); // string[] |
$xKillbillReason = "xKillbillReason_example"; // string |
$xKillbillComment = "xKillbillComment_example"; // string |
try {
$apiInstance->deleteBundleTags($bundleId, $xKillbillCreatedBy, $tagDef, $xKillbillReason, $xKillbillComment);
} catch (Exception $e) {
echo 'Exception when calling BundleApi->deleteBundleTags: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
bundleId | string | ||
xKillbillCreatedBy | string | ||
tagDef | string[] | [optional] | |
xKillbillReason | string | [optional] | |
xKillbillComment | string | [optional] |
void (empty response body)
[Killbill Api Key](../../README.md#Killbill Api Key), [Killbill Api Secret](../../README.md#Killbill Api Secret), basicAuth
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Killbill\Client\Swagger\Model\Bundle getBundle($bundleId, $audit)
Retrieve a bundle by id
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Killbill Api Key
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiKey', 'Bearer');// Configure API key authorization: Killbill Api Secret
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiSecret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiSecret', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new Killbill\Client\Swagger\Api\BundleApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$bundleId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string |
$audit = "audit_example"; // string |
try {
$result = $apiInstance->getBundle($bundleId, $audit);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BundleApi->getBundle: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
bundleId | string | ||
audit | string | [optional] |
\Killbill\Client\Swagger\Model\Bundle
[Killbill Api Key](../../README.md#Killbill Api Key), [Killbill Api Secret](../../README.md#Killbill Api Secret), basicAuth
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Killbill\Client\Swagger\Model\AuditLog[] getBundleAuditLogsWithHistory($bundleId)
Retrieve bundle audit logs with history by id
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Killbill Api Key
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiKey', 'Bearer');// Configure API key authorization: Killbill Api Secret
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiSecret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiSecret', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new Killbill\Client\Swagger\Api\BundleApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$bundleId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string |
try {
$result = $apiInstance->getBundleAuditLogsWithHistory($bundleId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BundleApi->getBundleAuditLogsWithHistory: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
bundleId | string |
\Killbill\Client\Swagger\Model\AuditLog[]
[Killbill Api Key](../../README.md#Killbill Api Key), [Killbill Api Secret](../../README.md#Killbill Api Secret), basicAuth
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Killbill\Client\Swagger\Model\Bundle[] getBundleByKey($externalKey, $includedDeleted, $audit)
Retrieve a bundle by external key
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Killbill Api Key
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiKey', 'Bearer');// Configure API key authorization: Killbill Api Secret
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiSecret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiSecret', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new Killbill\Client\Swagger\Api\BundleApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$externalKey = "externalKey_example"; // string |
$includedDeleted = true; // bool |
$audit = "audit_example"; // string |
try {
$result = $apiInstance->getBundleByKey($externalKey, $includedDeleted, $audit);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BundleApi->getBundleByKey: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
externalKey | string | ||
includedDeleted | bool | [optional] | |
audit | string | [optional] |
\Killbill\Client\Swagger\Model\Bundle[]
[Killbill Api Key](../../README.md#Killbill Api Key), [Killbill Api Secret](../../README.md#Killbill Api Secret), basicAuth
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Killbill\Client\Swagger\Model\CustomField[] getBundleCustomFields($bundleId, $audit)
Retrieve bundle custom fields
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Killbill Api Key
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiKey', 'Bearer');// Configure API key authorization: Killbill Api Secret
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiSecret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiSecret', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new Killbill\Client\Swagger\Api\BundleApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$bundleId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string |
$audit = "audit_example"; // string |
try {
$result = $apiInstance->getBundleCustomFields($bundleId, $audit);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BundleApi->getBundleCustomFields: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
bundleId | string | ||
audit | string | [optional] |
\Killbill\Client\Swagger\Model\CustomField[]
[Killbill Api Key](../../README.md#Killbill Api Key), [Killbill Api Secret](../../README.md#Killbill Api Secret), basicAuth
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Killbill\Client\Swagger\Model\Tag[] getBundleTags($bundleId, $includedDeleted, $audit)
Retrieve bundle tags
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Killbill Api Key
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiKey', 'Bearer');// Configure API key authorization: Killbill Api Secret
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiSecret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiSecret', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new Killbill\Client\Swagger\Api\BundleApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$bundleId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string |
$includedDeleted = true; // bool |
$audit = "audit_example"; // string |
try {
$result = $apiInstance->getBundleTags($bundleId, $includedDeleted, $audit);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BundleApi->getBundleTags: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
bundleId | string | ||
includedDeleted | bool | [optional] | |
audit | string | [optional] |
\Killbill\Client\Swagger\Model\Tag[]
[Killbill Api Key](../../README.md#Killbill Api Key), [Killbill Api Secret](../../README.md#Killbill Api Secret), basicAuth
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Killbill\Client\Swagger\Model\Bundle[] getBundles($offset, $limit, $audit)
List bundles
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Killbill Api Key
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiKey', 'Bearer');// Configure API key authorization: Killbill Api Secret
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiSecret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiSecret', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new Killbill\Client\Swagger\Api\BundleApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$offset = 789; // int |
$limit = 789; // int |
$audit = "audit_example"; // string |
try {
$result = $apiInstance->getBundles($offset, $limit, $audit);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BundleApi->getBundles: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
offset | int | [optional] | |
limit | int | [optional] | |
audit | string | [optional] |
\Killbill\Client\Swagger\Model\Bundle[]
[Killbill Api Key](../../README.md#Killbill Api Key), [Killbill Api Secret](../../README.md#Killbill Api Secret), basicAuth
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
modifyBundleCustomFields($body, $xKillbillCreatedBy, $bundleId, $xKillbillReason, $xKillbillComment)
Modify custom fields to bundle
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Killbill Api Key
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiKey', 'Bearer');// Configure API key authorization: Killbill Api Secret
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiSecret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiSecret', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new Killbill\Client\Swagger\Api\BundleApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$body = array(new \Killbill\Client\Swagger\Model\CustomField()); // \Killbill\Client\Swagger\Model\CustomField[] |
$xKillbillCreatedBy = "xKillbillCreatedBy_example"; // string |
$bundleId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string |
$xKillbillReason = "xKillbillReason_example"; // string |
$xKillbillComment = "xKillbillComment_example"; // string |
try {
$apiInstance->modifyBundleCustomFields($body, $xKillbillCreatedBy, $bundleId, $xKillbillReason, $xKillbillComment);
} catch (Exception $e) {
echo 'Exception when calling BundleApi->modifyBundleCustomFields: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Killbill\Client\Swagger\Model\CustomField[] | ||
xKillbillCreatedBy | string | ||
bundleId | string | ||
xKillbillReason | string | [optional] | |
xKillbillComment | string | [optional] |
void (empty response body)
[Killbill Api Key](../../README.md#Killbill Api Key), [Killbill Api Secret](../../README.md#Killbill Api Secret), basicAuth
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
pauseBundle($bundleId, $xKillbillCreatedBy, $requestedDate, $pluginProperty, $xKillbillReason, $xKillbillComment)
Pause a bundle
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Killbill Api Key
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiKey', 'Bearer');// Configure API key authorization: Killbill Api Secret
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiSecret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiSecret', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new Killbill\Client\Swagger\Api\BundleApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$bundleId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string |
$xKillbillCreatedBy = "xKillbillCreatedBy_example"; // string |
$requestedDate = new \DateTime("2013-10-20"); // \DateTime |
$pluginProperty = array("pluginProperty_example"); // string[] |
$xKillbillReason = "xKillbillReason_example"; // string |
$xKillbillComment = "xKillbillComment_example"; // string |
try {
$apiInstance->pauseBundle($bundleId, $xKillbillCreatedBy, $requestedDate, $pluginProperty, $xKillbillReason, $xKillbillComment);
} catch (Exception $e) {
echo 'Exception when calling BundleApi->pauseBundle: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
bundleId | string | ||
xKillbillCreatedBy | string | ||
requestedDate | \DateTime | [optional] | |
pluginProperty | string[] | [optional] | |
xKillbillReason | string | [optional] | |
xKillbillComment | string | [optional] |
void (empty response body)
[Killbill Api Key](../../README.md#Killbill Api Key), [Killbill Api Secret](../../README.md#Killbill Api Secret), basicAuth
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
renameExternalKey($body, $xKillbillCreatedBy, $bundleId, $xKillbillReason, $xKillbillComment)
Update a bundle externalKey
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Killbill Api Key
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiKey', 'Bearer');// Configure API key authorization: Killbill Api Secret
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiSecret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiSecret', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new Killbill\Client\Swagger\Api\BundleApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$body = new \Killbill\Client\Swagger\Model\Bundle(); // \Killbill\Client\Swagger\Model\Bundle |
$xKillbillCreatedBy = "xKillbillCreatedBy_example"; // string |
$bundleId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string |
$xKillbillReason = "xKillbillReason_example"; // string |
$xKillbillComment = "xKillbillComment_example"; // string |
try {
$apiInstance->renameExternalKey($body, $xKillbillCreatedBy, $bundleId, $xKillbillReason, $xKillbillComment);
} catch (Exception $e) {
echo 'Exception when calling BundleApi->renameExternalKey: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Killbill\Client\Swagger\Model\Bundle | ||
xKillbillCreatedBy | string | ||
bundleId | string | ||
xKillbillReason | string | [optional] | |
xKillbillComment | string | [optional] |
void (empty response body)
[Killbill Api Key](../../README.md#Killbill Api Key), [Killbill Api Secret](../../README.md#Killbill Api Secret), basicAuth
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
resumeBundle($bundleId, $xKillbillCreatedBy, $requestedDate, $pluginProperty, $xKillbillReason, $xKillbillComment)
Resume a bundle
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Killbill Api Key
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiKey', 'Bearer');// Configure API key authorization: Killbill Api Secret
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiSecret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiSecret', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new Killbill\Client\Swagger\Api\BundleApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$bundleId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string |
$xKillbillCreatedBy = "xKillbillCreatedBy_example"; // string |
$requestedDate = new \DateTime("2013-10-20"); // \DateTime |
$pluginProperty = array("pluginProperty_example"); // string[] |
$xKillbillReason = "xKillbillReason_example"; // string |
$xKillbillComment = "xKillbillComment_example"; // string |
try {
$apiInstance->resumeBundle($bundleId, $xKillbillCreatedBy, $requestedDate, $pluginProperty, $xKillbillReason, $xKillbillComment);
} catch (Exception $e) {
echo 'Exception when calling BundleApi->resumeBundle: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
bundleId | string | ||
xKillbillCreatedBy | string | ||
requestedDate | \DateTime | [optional] | |
pluginProperty | string[] | [optional] | |
xKillbillReason | string | [optional] | |
xKillbillComment | string | [optional] |
void (empty response body)
[Killbill Api Key](../../README.md#Killbill Api Key), [Killbill Api Secret](../../README.md#Killbill Api Secret), basicAuth
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Killbill\Client\Swagger\Model\Bundle[] searchBundles($searchKey, $offset, $limit, $audit)
Search bundles
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Killbill Api Key
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiKey', 'Bearer');// Configure API key authorization: Killbill Api Secret
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiSecret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiSecret', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new Killbill\Client\Swagger\Api\BundleApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$searchKey = "searchKey_example"; // string |
$offset = 789; // int |
$limit = 789; // int |
$audit = "audit_example"; // string |
try {
$result = $apiInstance->searchBundles($searchKey, $offset, $limit, $audit);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BundleApi->searchBundles: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
searchKey | string | ||
offset | int | [optional] | |
limit | int | [optional] | |
audit | string | [optional] |
\Killbill\Client\Swagger\Model\Bundle[]
[Killbill Api Key](../../README.md#Killbill Api Key), [Killbill Api Secret](../../README.md#Killbill Api Secret), basicAuth
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Killbill\Client\Swagger\Model\Bundle transferBundle($body, $xKillbillCreatedBy, $bundleId, $xKillbillReason, $xKillbillComment, $requestedDate, $billingPolicy, $pluginProperty)
Transfer a bundle to another account
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: Killbill Api Key
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiKey', 'Bearer');// Configure API key authorization: Killbill Api Secret
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKey('X-Killbill-ApiSecret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Killbill-ApiSecret', 'Bearer');// Configure HTTP basic authorization: basicAuth
$config = Killbill\Client\Swagger\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new Killbill\Client\Swagger\Api\BundleApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$body = new \Killbill\Client\Swagger\Model\Bundle(); // \Killbill\Client\Swagger\Model\Bundle |
$xKillbillCreatedBy = "xKillbillCreatedBy_example"; // string |
$bundleId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string |
$xKillbillReason = "xKillbillReason_example"; // string |
$xKillbillComment = "xKillbillComment_example"; // string |
$requestedDate = new \DateTime("2013-10-20"); // \DateTime |
$billingPolicy = "billingPolicy_example"; // string |
$pluginProperty = array("pluginProperty_example"); // string[] |
try {
$result = $apiInstance->transferBundle($body, $xKillbillCreatedBy, $bundleId, $xKillbillReason, $xKillbillComment, $requestedDate, $billingPolicy, $pluginProperty);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BundleApi->transferBundle: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Killbill\Client\Swagger\Model\Bundle | ||
xKillbillCreatedBy | string | ||
bundleId | string | ||
xKillbillReason | string | [optional] | |
xKillbillComment | string | [optional] | |
requestedDate | \DateTime | [optional] | |
billingPolicy | string | [optional] | |
pluginProperty | string[] | [optional] |
\Killbill\Client\Swagger\Model\Bundle
[Killbill Api Key](../../README.md#Killbill Api Key), [Killbill Api Secret](../../README.md#Killbill Api Secret), basicAuth
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]