v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Billing

Billing Period Options

Returns a predefined list of billing period values with the valid billing cycles for the period that are supported by the system. The endpoint is typically used to populate dropdowns or selection fields in user interfaces or to enforce business rules.

get/v3/billing/option-items/billing-periods

Headers

FrontOfficeTenantIdinteger required

An integer identifier for the tenant that the request is being made for.

RequestOriginstring required

The string source name (such as application or function name) that indicates the origin of the request.

RequestIdstring uuid required

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

RequestUserExternalIdstring
Example:ABC123

The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.

Response

A predefined list of billing period values with the valid billing cycles.

billingPeriod'Unknown' | 'Weekly' | 'BiWeekly' | 'Monthly' | 'SemiMonthly' | 'Daily' | 'Yearly' | 'Hourly'

An option to define the billing frequency of billing processing.

validBillingCyclesBillPeriodCycle[]