You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+1-4
Original file line number
Diff line number
Diff line change
@@ -117,17 +117,14 @@ Class | Method | Description
117
117
[*BackendApi*](docs/Api/BackendApi.md) | [**getBackend**](docs/Api/BackendApi.md#getbackend) | Describe a backend
118
118
[*BackendApi*](docs/Api/BackendApi.md) | [**listBackends**](docs/Api/BackendApi.md#listbackends) | List backends
119
119
[*BackendApi*](docs/Api/BackendApi.md) | [**updateBackend**](docs/Api/BackendApi.md#updatebackend) | Update a backend
120
-
[*BillingApi*](docs/Api/BillingApi.md) | [**getInvoice**](docs/Api/BillingApi.md#getinvoice) | Get an invoice
121
-
[*BillingApi*](docs/Api/BillingApi.md) | [**getInvoiceById**](docs/Api/BillingApi.md#getinvoicebyid) | Get an invoice
122
-
[*BillingApi*](docs/Api/BillingApi.md) | [**getInvoiceMtd**](docs/Api/BillingApi.md#getinvoicemtd) | Get month-to-date billing estimate
123
120
[*BillingAddressApi*](docs/Api/BillingAddressApi.md) | [**addBillingAddr**](docs/Api/BillingAddressApi.md#addbillingaddr) | Add a billing address to a customer
124
121
[*BillingAddressApi*](docs/Api/BillingAddressApi.md) | [**deleteBillingAddr**](docs/Api/BillingAddressApi.md#deletebillingaddr) | Delete a billing address
125
122
[*BillingAddressApi*](docs/Api/BillingAddressApi.md) | [**getBillingAddr**](docs/Api/BillingAddressApi.md#getbillingaddr) | Get a billing address
126
123
[*BillingAddressApi*](docs/Api/BillingAddressApi.md) | [**updateBillingAddr**](docs/Api/BillingAddressApi.md#updatebillingaddr) | Update a billing address
127
124
[*BillingInvoicesApi*](docs/Api/BillingInvoicesApi.md) | [**getInvoiceByInvoiceId**](docs/Api/BillingInvoicesApi.md#getinvoicebyinvoiceid) | Get invoice by ID.
128
125
[*BillingInvoicesApi*](docs/Api/BillingInvoicesApi.md) | [**getMonthToDateInvoice**](docs/Api/BillingInvoicesApi.md#getmonthtodateinvoice) | Get month-to-date invoice.
129
126
[*BillingInvoicesApi*](docs/Api/BillingInvoicesApi.md) | [**listInvoices**](docs/Api/BillingInvoicesApi.md#listinvoices) | List of invoices.
130
-
[*BillingUsageMetricsApi*](docs/Api/BillingUsageMetricsApi.md) | [**getServiceLevelUsage**](docs/Api/BillingUsageMetricsApi.md#getservicelevelusage) | Retrieve service-level usage metrics for a product.
127
+
[*BillingUsageMetricsApi*](docs/Api/BillingUsageMetricsApi.md) | [**getServiceLevelUsage**](docs/Api/BillingUsageMetricsApi.md#getservicelevelusage) | Retrieve service-level usage metrics for services with non-zero usage units.
131
128
[*BillingUsageMetricsApi*](docs/Api/BillingUsageMetricsApi.md) | [**getUsageMetrics**](docs/Api/BillingUsageMetricsApi.md#getusagemetrics) | Get monthly usage metrics
132
129
[*CacheSettingsApi*](docs/Api/CacheSettingsApi.md) | [**createCacheSettings**](docs/Api/CacheSettingsApi.md#createcachesettings) | Create a cache settings object
133
130
[*CacheSettingsApi*](docs/Api/CacheSettingsApi.md) | [**deleteCacheSettings**](docs/Api/CacheSettingsApi.md#deletecachesettings) | Delete a cache settings object
Copy file name to clipboardExpand all lines: docs/Api/BillingUsageMetricsApi.md
+10-8
Original file line number
Diff line number
Diff line change
@@ -17,25 +17,26 @@ $apiInstance = new Fastly\Api\BillingUsageMetricsApi(
17
17
18
18
Method | HTTP request | Description
19
19
------ | ------------ | -----------
20
-
[**getServiceLevelUsage()**](BillingUsageMetricsApi.md#getServiceLevelUsage) | **GET** /billing/v3/service-usage-metrics | Retrieve service-level usage metrics for a product.
20
+
[**getServiceLevelUsage()**](BillingUsageMetricsApi.md#getServiceLevelUsage) | **GET** /billing/v3/service-usage-metrics | Retrieve service-level usage metrics for services with non-zero usage units.
21
21
[**getUsageMetrics()**](BillingUsageMetricsApi.md#getUsageMetrics) | **GET** /billing/v3/usage-metrics | Get monthly usage metrics
22
22
23
23
24
24
## `getServiceLevelUsage()`
25
25
26
26
```php
27
-
getServiceLevelUsage($options): \Fastly\Model\Serviceusagemetrics // Retrieve service-level usage metrics for a product.
27
+
getServiceLevelUsage($options): \Fastly\Model\Serviceusagemetrics // Retrieve service-level usage metrics for services with non-zero usage units.
28
28
```
29
29
30
30
Returns product usage, broken down by service.
31
31
32
32
### Example
33
33
```php
34
-
$options['product_id'] = 'product_id_example'; // string | The product identifier for the metrics returned (e.g., `cdn_usage`).
35
-
$options['usage_type_name'] = 'usage_type_name_example'; // string | The usage type name for the metrics returned (e.g., `North America Requests`).
34
+
$options['product_id'] = 'product_id_example'; // string | The product identifier for the metrics returned (e.g., `cdn_usage`). This should be used along with `usage_type_name`.
35
+
$options['service'] = 'service_example'; // string | The service identifier for the metrics being requested.
36
+
$options['usage_type_name'] = 'usage_type_name_example'; // string | The usage type name for the metrics returned (e.g., `North America Requests`). This should be used along with `product_id`.
36
37
$options['start_month'] = 2023-01; // string
37
38
$options['end_month'] = 2023-03; // string
38
-
$options['limit'] = '5'; // string | Number of results per page. The maximum is 100.
39
+
$options['limit'] = '1000'; // string | Number of results per page. The maximum is 10000.
39
40
$options['cursor'] = 'cursor_example'; // string | Cursor value from the `next_cursor` field of a previous response, used to retrieve the next page. To request the first page, this should be empty.
40
41
41
42
try {
@@ -51,11 +52,12 @@ Note: the input parameter is an associative array with the keys listed below.
**product_id** | **string** | The product identifier for the metrics returned (e.g., `cdn_usage`). | [optional]
55
-
**usage_type_name** | **string** | The usage type name for the metrics returned (e.g., `North America Requests`). | [optional]
55
+
**product_id** | **string** | The product identifier for the metrics returned (e.g., `cdn_usage`). This should be used along with `usage_type_name`. | [optional]
56
+
**service** | **string** | The service identifier for the metrics being requested. | [optional]
57
+
**usage_type_name** | **string** | The usage type name for the metrics returned (e.g., `North America Requests`). This should be used along with `product_id`. | [optional]
56
58
**start_month** | **string** | | [optional]
57
59
**end_month** | **string** | | [optional]
58
-
**limit** | **string** | Number of results per page. The maximum is 100. | [optional][defaults to '5']
60
+
**limit** | **string** | Number of results per page. The maximum is 10000. | [optional][defaults to '1000']
59
61
**cursor** | **string** | Cursor value from the `next_cursor` field of a previous response, used to retrieve the next page. To request the first page, this should be empty. | [optional]
$options['src'] = 'src_example'; // string | Variable to be used as a source for the header content. Does not apply to `delete` action.
47
47
$options['substitution'] = 'substitution_example'; // string | Value to substitute in place of regular expression. Only applies to `regex` and `regex_repeat` actions.
48
48
$options['type'] = 'type_example'; // string | Accepts a string value.
49
-
$options['ignore_if_set'] = 56; // int | Don't add the header if it is added already. Only applies to 'set' action.
$options['ignore_if_set'] = 'ignore_if_set_example'; // string | Don't add the header if it is added already. Only applies to 'set' action. Numerical value (\\\"0\\\" = false, \\\"1\\\" = true)
**ignore_if_set** | **string** | Don't add the header if it is added already. Only applies to 'set' action. Numerical value (\\\"0\\\" = false, \\\"1\\\" = true) | [optional]
$options['src'] = 'src_example'; // string | Variable to be used as a source for the header content. Does not apply to `delete` action.
220
220
$options['substitution'] = 'substitution_example'; // string | Value to substitute in place of regular expression. Only applies to `regex` and `regex_repeat` actions.
221
221
$options['type'] = 'type_example'; // string | Accepts a string value.
222
-
$options['ignore_if_set'] = 56; // int | Don't add the header if it is added already. Only applies to 'set' action.
$options['ignore_if_set'] = 'ignore_if_set_example'; // string | Don't add the header if it is added already. Only applies to 'set' action. Numerical value (\\\"0\\\" = false, \\\"1\\\" = true)
**ignore_if_set** | **string** | Don't add the header if it is added already. Only applies to 'set' action. Numerical value (\\\"0\\\" = false, \\\"1\\\" = true) | [optional]
0 commit comments