Skip to content

Latest commit

 

History

History
194 lines (139 loc) · 8.36 KB

BillingApi.md

File metadata and controls

194 lines (139 loc) · 8.36 KB
Raw

ZeC128\AppCenter\BillingApi

All URIs are relative to https://api.appcenter.ms

Method HTTP request Description
billingAggregatedInformationGetAll GET /v0.1/billing/allAccountsAggregated
billingAggregatedInformationGetByApp GET /v0.1/apps/{owner_name}/{app_name}/billing/aggregated
billingAggregatedInformationGetForOrg GET /v0.1/orgs/{orgName}/billing/aggregated

billingAggregatedInformationGetAll

\ZeC128\AppCenter\AppCenterApi\InlineResponse20016 billingAggregatedInformationGetAll($service, $period, $show_original_plans)

Aggregated Billing Information for the requesting user and the organizations in which the user is an admin.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: APIToken
$config = ZeC128\AppCenter\Configuration::getDefaultConfiguration()->setApiKey('X-API-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ZeC128\AppCenter\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Token', 'Bearer');

$apiInstance = new ZeC128\AppCenter\Api\BillingApi(
    // 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
);
$service = "service_example"; // string | Type of service that should be included in the Billing Information
$period = "period_example"; // string | Type of period that should be included in the Billing Information
$show_original_plans = true; // bool | Controls whether the API should show the original plan when Azure Subscription is not enabled

try {
    $result = $apiInstance->billingAggregatedInformationGetAll($service, $period, $show_original_plans);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BillingApi->billingAggregatedInformationGetAll: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
service string Type of service that should be included in the Billing Information [optional]
period string Type of period that should be included in the Billing Information [optional]
show_original_plans bool Controls whether the API should show the original plan when Azure Subscription is not enabled [optional]

Return type

\ZeC128\AppCenter\AppCenterApi\InlineResponse20016

Authorization

APIToken

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

billingAggregatedInformationGetByApp

\ZeC128\AppCenter\AppCenterApi\InlineResponse20013 billingAggregatedInformationGetByApp($owner_name, $app_name, $service, $period, $show_original_plans)

Aggregated Billing Information for owner of a given app.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: APIToken
$config = ZeC128\AppCenter\Configuration::getDefaultConfiguration()->setApiKey('X-API-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ZeC128\AppCenter\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Token', 'Bearer');

$apiInstance = new ZeC128\AppCenter\Api\BillingApi(
    // 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
);
$owner_name = "owner_name_example"; // string | The name of the owner
$app_name = "app_name_example"; // string | The name of the application
$service = "service_example"; // string | Type of service that should be included in the Billing Information
$period = "period_example"; // string | Type of period that should be included in the Billing Information
$show_original_plans = true; // bool | Controls whether the API should show the original plan when Azure Subscription is not enabled

try {
    $result = $apiInstance->billingAggregatedInformationGetByApp($owner_name, $app_name, $service, $period, $show_original_plans);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BillingApi->billingAggregatedInformationGetByApp: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
owner_name string The name of the owner
app_name string The name of the application
service string Type of service that should be included in the Billing Information [optional]
period string Type of period that should be included in the Billing Information [optional]
show_original_plans bool Controls whether the API should show the original plan when Azure Subscription is not enabled [optional]

Return type

\ZeC128\AppCenter\AppCenterApi\InlineResponse20013

Authorization

APIToken

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

billingAggregatedInformationGetForOrg

\ZeC128\AppCenter\AppCenterApi\InlineResponse20013 billingAggregatedInformationGetForOrg($org_name, $service, $period, $show_original_plans)

Aggregated Billing Information for a given Organization.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: APIToken
$config = ZeC128\AppCenter\Configuration::getDefaultConfiguration()->setApiKey('X-API-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ZeC128\AppCenter\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Token', 'Bearer');

$apiInstance = new ZeC128\AppCenter\Api\BillingApi(
    // 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
);
$org_name = "org_name_example"; // string | The name of the Organization
$service = "service_example"; // string | Type of service that should be included in the Billing Information
$period = "period_example"; // string | Type of period that should be included in the Billing Information
$show_original_plans = true; // bool | Controls whether the API should show the original plan when Azure Subscription is not enabled

try {
    $result = $apiInstance->billingAggregatedInformationGetForOrg($org_name, $service, $period, $show_original_plans);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BillingApi->billingAggregatedInformationGetForOrg: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
org_name string The name of the Organization
service string Type of service that should be included in the Billing Information [optional]
period string Type of period that should be included in the Billing Information [optional]
show_original_plans bool Controls whether the API should show the original plan when Azure Subscription is not enabled [optional]

Return type

\ZeC128\AppCenter\AppCenterApi\InlineResponse20013

Authorization

APIToken

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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