Child pages
  • Admin API Complex Type productOffer

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
The ProductOffer class holds the base data for each product offer.
Derived By
Extending resource
Content Model
Contains elements as defined in the following table.

Component

Type

Occurs

Description

billingEntityUUID

string

0..1

The UUID of the Billing Entity to which the resource belongs

resourceCreateDate

dateTime

0..1

The creation date of the resource

resourceKey

resourceKey

0..*

The keys attached to the resource

resourceMetadata

resourceMetadata

0..1

The metadata attached to the resource

resourceName

string

0..1

The name of the resource

resourceState

resourceState

0..1

The state of the resource

resourceType

resourceType

0..1

The type of the resource

resourceUUID

string

0..1

The UUID of the resource (read-only)

description

string

0..1

The description of the product offer

currencyId

int

1..1

The numeric currency ID associated with the product offer

initialCharge

double

1..1

The initial currency charge associated with the product offer

repeatPeriod

periodType

0..1

The repeat period associated with the product offer

repeatUnits

double

1..1

The unit charge associated with the product offer; for autotopup product offers this will be a positive value, and for resource product offers, this will normally be negative or zero. Note that the same field is used for non-repeat unit charges too.

repeatCharge

double

1..1

The repeating currency charge associated with the product offer

minimumPeriod

int

1..1

The minimum period associated with the product offer

noticePeriod

int

1..1

The notice period of cancellation associated with the product offer

onCredit

boolean

1..1

A flag to indicate whether the product offer can be supplied on credit

productId

long

1..1

The numeric ID of the product with which the product offer is associated

minimumUnits

double

1..1

This field is reserved and should be written as zero

unitType

unitType

0..1

The type of units associated with the product offer (carry-over=0 or non-carryover=1)

autoTopupBalanceThreshold

long

1..1

The unit balance threshold at which an auto topup occurs, for a topup product offer

advertise

boolean

1..1

A flag to indicate whether the product offer should be advertised

productType

productType

0..1

The product type / product component associated with the product offer

product

product

0..1

The product with which the product offer is associated

clusters

string

0..*

The list of clusters to which productoffer belongs to

  • No labels