Transaction Class

A transaction.

Variables are only populated by the server, and will be ignored when sending a request.

Constructor

Transaction(*, kind: str | _models.TransactionTypeKind | None = None, transaction_type: str | _models.ReservationType | None = None, **kwargs)

Keyword-Only Parameters

Name	Description
kind	str or TransactionTypeKind The kind of transaction. Options are all or reservation. Known values are: "all" and "reservation". Default value: None
transaction_type	str or ReservationType The type of transaction. Known values are: "Purchase" and "Usage Charge". Default value: None

Variables

Name	Description
id	str Resource Id.
name	str Resource name.
type	str Resource type.
kind	str or TransactionTypeKind The kind of transaction. Options are all or reservation. Known values are: "all" and "reservation".
date	datetime The date of transaction.
invoice	str Invoice on which the transaction was billed or 'pending' if the transaction is not billed.
invoice_id	str The ID of the invoice on which the transaction was billed. This field is only applicable for transactions which are billed.
order_id	str The order ID of the reservation. The field is only applicable for transaction of kind reservation.
order_name	str The name of the reservation order. The field is only applicable for transactions of kind reservation.
product_family	str The family of the product for which the transaction took place.
product_type_id	str The ID of the product type for which the transaction took place.
product_type	str The type of the product for which the transaction took place.
product_description	str The description of the product for which the transaction took place.
transaction_type	str or ReservationType The type of transaction. Known values are: "Purchase" and "Usage Charge".
transaction_amount	Amount The charge associated with the transaction.
quantity	int The quantity purchased in the transaction.
invoice_section_id	str The ID of the invoice section which will be billed for the transaction.
invoice_section_display_name	str The name of the invoice section which will be billed for the transaction.
billing_profile_id	str The ID of the billing profile which will be billed for the transaction.
billing_profile_display_name	str The name of the billing profile which will be billed for the transaction.
customer_id	str The ID of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account.
customer_display_name	str The name of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account.
subscription_id	str The ID of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation.
subscription_name	str The name of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation.
azure_plan	str The type of azure plan of the subscription that was used for the transaction.
azure_credit_applied	Amount The amount of any Azure credits automatically applied to this transaction.
billing_currency	str The ISO 4217 code for the currency in which this transaction is billed.
discount	float The percentage discount, if any, applied to this transaction.
effective_price	Amount The price of the product after applying any discounts.
exchange_rate	float The exchange rate used to convert charged amount to billing currency, if applicable.
market_price	Amount The retail price of the product.
pricing_currency	str The ISO 4217 code for the currency in which the product is priced.
service_period_start_date	datetime The date of the purchase of the product, or the start date of the month in which usage started.
service_period_end_date	datetime The end date of the product term, or the end date of the month in which usage ended.
sub_total	Amount The pre-tax charged amount for the transaction.
tax	Amount The tax amount applied to the transaction.
unit_of_measure	str The unit of measure used to bill for the product. For example, compute services are billed per hour.
units	float The number of units used for a given product.
unit_type	str The description for the unit of measure for a given product.