M3m3ter-com
Bill

Retrieve Bills in Billing Period

Changed on

Retrieve all Bills within a specified billing period. This endpoint allows you to retrieve Bills on various frequencies, such as daily, weekly, monthly, or annually. Specify the last day of the period to define the range.

For example, to retrieve all Bills on monthly billing up to September with due date of 1st of month, use the last day of September, which is September 30th.

The list can also be paginated for easier management.

get/organizations/{orgId}/bills/billingperiod/{lastDateInBillingPeriod}/{billingFrequency}

Request

Path parameters

orgIdstring required

The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.

lastDateInBillingPeriodstring required

The last date of the billing period for which you want to retrieve Bills. This date defines the range of Bills to be retrieved.

billingFrequencystring required

The billing frequency for the specified period. Valid options are daily, weekly, monthly, or annually.

Query parameters

pageSizeinteger

Specifies the maximum number of Bills to retrieve per page.

nextTokenstring

The nextToken for multi-page retrievals. It is used to fetch the next page of Bills in a paginated list.

additionalstring[]

Comma separated list of additional fields.

Response

Returns the list of Bills within the billing period

nextTokenstring

Example response

{
  "data": [
    {
      "timezone": "UTC",
      "currencyConversions": [
        {
          "from": "EUR",
          "to": "USD",
          "multiplier": 1.12
        }
      ]
    }
  ]
}

Changes

  • 85c514abc692Revision changes
    • breaking

      the ////// response's property type changed from no type to object for status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • ac93d1a9e6d9Revision changes
    • warning

      added the new AD_HOC enum value to the //// response property for the response status

    • info

      added the optional property // to the response with the status