Child pages
  • Admin API Complex Type referralPromotion

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 ReferralScheme class holds the base data for each referral scheme.
Derived By
Extending promotion
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)

startDate

dateTime

0..1

The start date of the promotion code type

endDate

dateTime

0..1

The end date date of the promotion code type

productOfferUUID

string

0..1

The numeric product offer ID associated with the promotion code

noCardCheck

boolean

1..1

A flag to indicate whether a card check can be skipped with the promotion code

priority

int

1..1

The priority of the referral scheme

invitorProductOfferUUID

string

0..1

The number of units the invitor receives on successful completion

inviteeMinimumPurchase

int

1..1

The minimum unit purchase by the invitee to achieve successful completion

unitCost

double

1..1

The cost to the invitor's outstanding invitation balance

maxOutStanding

int

1..1

The maximum number of outstanding instances of this referral promotion

  • No labels