Child pages
  • Admin API Method getPurchasedUnits

This documentation is for a previous version of Flexiant Cloud Orchestrator. The most recent version is v5.0. For the most recent documentation please see here

Skip to end of metadata
Go to start of metadata

Description
This function searches for a list of units purchased within a given date range and for a given Billing Entity ID.
Style
Document
Input (Literal)
The input of this method is the argument getPurchasedUnits of type getPurchasedUnits having the structure defined by the following table.

Element

Type

Occurs

Description

from

dateTime

0..1

The start of the date range

to

dateTime

0..1

The end of the date range

billingEntityUUID

string

0..1

The UUID of associated billing entity

Output (Literal)
The output of this method is the argument getPurchasedUnitsResponse of type getPurchasedUnitsResponse having the structure defined by the following table.

Element

Type

Occurs

Description

getPurchasedUnits

purchasedUnits

0..*

The list of purchased units

Remarks
On an exception, no unit purchases are returned.
Each unit purchase record represents a unit purchase (either via a single shot purchase or a unit topup) for a given customer. For more details, see the purchasedUnits complex type.

  • No labels