docs/BillingInvoicesApi.md in fastly-8.5.0 vs docs/BillingInvoicesApi.md in fastly-8.6.0

- old
+ new

@@ -12,17 +12,18 @@ > All URIs are relative to `https://api.fastly.com` Method | HTTP request | Description ------ | ------------ | ----------- [**get_invoice_by_invoice_id**](BillingInvoicesApi.md#get_invoice_by_invoice_id) | **GET** /billing/v3/invoices/{invoice_id} | Get invoice by ID. +[**get_month_to_date_invoice**](BillingInvoicesApi.md#get_month_to_date_invoice) | **GET** /billing/v3/invoices/month-to-date | Get month-to-date invoice. [**list_invoices**](BillingInvoicesApi.md#list_invoices) | **GET** /billing/v3/invoices | List of invoices. ## `get_invoice_by_invoice_id()` ```ruby -get_invoice_by_invoice_id(opts): <InvoiceResponse> # Get invoice by ID. +get_invoice_by_invoice_id(opts): <EomInvoiceResponse> # Get invoice by ID. ``` Returns invoice associated with the invoice id. ### Examples @@ -48,18 +49,50 @@ | ---- | ---- | ----------- | ----- | | **invoice_id** | **String** | Alphanumeric string identifying the invoice. | | ### Return type -[**InvoiceResponse**](InvoiceResponse.md) +[**EomInvoiceResponse**](EomInvoiceResponse.md) [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) +## `get_month_to_date_invoice()` + +```ruby +get_month_to_date_invoice: <MtdInvoiceResponse> # Get month-to-date invoice. +``` + +Returns month-to-date invoice for the current month. + +### Examples + +```ruby +api_instance = Fastly::BillingInvoicesApi.new + +begin + # Get month-to-date invoice. + result = api_instance.get_month_to_date_invoice + p result +rescue Fastly::ApiError => e + puts "Error when calling BillingInvoicesApi->get_month_to_date_invoice: #{e}" +end +``` + +### Options + +This endpoint does not need any parameter. + +### Return type + +[**MtdInvoiceResponse**](MtdInvoiceResponse.md) + +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) +[[Back to README]](../../README.md) ## `list_invoices()` ```ruby -list_invoices(opts): <ListInvoicesResponse> # List of invoices. +list_invoices(opts): <ListEomInvoicesResponse> # List of invoices. ``` Returns the list of invoices, sorted by billing start date (newest to oldest). ### Examples @@ -91,9 +124,9 @@ | **limit** | **String** | Number of results per page. The maximum is 200. | [optional][default to &#39;100&#39;] | | **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] | ### Return type -[**ListInvoicesResponse**](ListInvoicesResponse.md) +[**ListEomInvoicesResponse**](ListEomInvoicesResponse.md) [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)