RedemptionSummary¶
- class oci.usage.models.RedemptionSummary(**kwargs)¶
Bases:
objectThe redemption summary for the requested subscription ID and date range.
Methods:
__init__(**kwargs)Initializes a new RedemptionSummary object with values from keyword arguments.
Attributes:
Gets the base_rewards of this RedemptionSummary.
Gets the fx_rate of this RedemptionSummary.
Gets the invoice_currency of this RedemptionSummary.
Gets the invoice_number of this RedemptionSummary.
Gets the invoice_total_amount of this RedemptionSummary.
Gets the redeemed_rewards of this RedemptionSummary.
Gets the redemption_code of this RedemptionSummary.
Gets the redemption_email of this RedemptionSummary.
Gets the time_invoiced of this RedemptionSummary.
Gets the time_redeemed of this RedemptionSummary.
- __init__(**kwargs)¶
Initializes a new RedemptionSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
time_redeemed (datetime) – The value to assign to the time_redeemed property of this RedemptionSummary.
redemption_email (str) – The value to assign to the redemption_email property of this RedemptionSummary.
redemption_code (str) – The value to assign to the redemption_code property of this RedemptionSummary.
invoice_number (str) – The value to assign to the invoice_number property of this RedemptionSummary.
invoice_total_amount (float) – The value to assign to the invoice_total_amount property of this RedemptionSummary.
invoice_currency (str) – The value to assign to the invoice_currency property of this RedemptionSummary.
redeemed_rewards (float) – The value to assign to the redeemed_rewards property of this RedemptionSummary.
base_rewards (float) – The value to assign to the base_rewards property of this RedemptionSummary.
fx_rate (float) – The value to assign to the fx_rate property of this RedemptionSummary.
time_invoiced (datetime) – The value to assign to the time_invoiced property of this RedemptionSummary.
- property base_rewards¶
Gets the base_rewards of this RedemptionSummary. It provides the redeemed rewards in base/subscription currency.
- Returns
The base_rewards of this RedemptionSummary.
- Return type
float
- property fx_rate¶
Gets the fx_rate of this RedemptionSummary. It provides the fxRate between invoice currency and subscription currency.
- Returns
The fx_rate of this RedemptionSummary.
- Return type
float
- property invoice_currency¶
Gets the invoice_currency of this RedemptionSummary. The currency associated with invoice.
- Returns
The invoice_currency of this RedemptionSummary.
- Return type
str
- property invoice_number¶
Gets the invoice_number of this RedemptionSummary. It provides the invoice number against the redemption.
- Returns
The invoice_number of this RedemptionSummary.
- Return type
str
- property invoice_total_amount¶
Gets the invoice_total_amount of this RedemptionSummary. It provides the invoice total amount of given redemption.
- Returns
The invoice_total_amount of this RedemptionSummary.
- Return type
float
- property redeemed_rewards¶
Gets the redeemed_rewards of this RedemptionSummary. It provides the redeemed rewards in invoice currency.
- Returns
The redeemed_rewards of this RedemptionSummary.
- Return type
float
- property redemption_code¶
Gets the redemption_code of this RedemptionSummary. The redemption code used in the Billing Center during the reward redemption process.
- Returns
The redemption_code of this RedemptionSummary.
- Return type
str
- property redemption_email¶
Gets the redemption_email of this RedemptionSummary. It provides the redemption email id.
- Returns
The redemption_email of this RedemptionSummary.
- Return type
str
- property time_invoiced¶
Gets the time_invoiced of this RedemptionSummary. It provides the invoice date.
- Returns
The time_invoiced of this RedemptionSummary.
- Return type
datetime
- property time_redeemed¶
Gets the time_redeemed of this RedemptionSummary. It provides redeem date.
- Returns
The time_redeemed of this RedemptionSummary.
- Return type
datetime