BillingSubscriptionProperties Class
The billing properties of a subscription.
Constructor
BillingSubscriptionProperties(*args: Any, **kwargs: Any)
Variables
| Name | Description |
|---|---|
|
auto_renew
|
Indicates whether auto renewal is turned on or off for a product. Known values are: "Off" and "On". |
|
beneficiary_tenant_id
|
The provisioning tenant of the subscription. |
|
beneficiary
|
The beneficiary of the billing subscription. |
|
billing_frequency
|
The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y. |
|
billing_profile_id
|
The fully qualified ID that uniquely identifies a billing profile. |
|
billing_policies
|
Dictionary of billing policies associated with the subscription. |
|
billing_profile_display_name
|
The name of the billing profile. |
|
billing_profile_name
|
The ID that uniquely identifies a billing profile. |
|
consumption_cost_center
|
The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts. |
|
customer_id
|
The fully qualified ID that uniquely identifies a customer. |
|
customer_display_name
|
The name of the customer. |
|
customer_name
|
The ID that uniquely identifies a customer. |
|
display_name
|
The name of the billing subscription. |
|
enrollment_account_id
|
The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. |
|
enrollment_account_display_name
|
The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts. |
|
enrollment_account_subscription_details
|
Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts. |
|
invoice_section_id
|
The fully qualified ID that uniquely identifies an invoice section. |
|
invoice_section_display_name
|
The name of the invoice section. |
|
invoice_section_name
|
The ID that uniquely identifies an invoice section. |
|
last_month_charges
|
The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. |
|
month_to_date_charges
|
The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts. |
|
next_billing_cycle_details
|
Next billing cycle details of the subscription. |
|
offer_id
|
The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement. |
|
product_category
|
The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other. |
|
product_type
|
Type of the product for which the subscription is purchased. |
|
product_type_id
|
Id of the product for which the subscription is purchased. |
|
purchase_date
|
Purchase date of the product in UTC time. |
|
quantity
|
The quantity of licenses or fulfillment units for the subscription. |
|
reseller
|
Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts. |
|
renewal_term_details
|
Details for the next renewal term of a subscription. |
|
sku_id
|
The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts. |
|
sku_description
|
The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement. |
|
system_overrides
|
System imposed policies that regulate behavior of the subscription. |
|
resource_uri
|
Unique identifier of the linked resource. |
|
term_duration
|
The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y. |
|
term_start_date
|
Start date of the term in UTC time. |
|
term_end_date
|
End date of the term in UTC time. |
|
provisioning_tenant_id
|
The tenant in which the subscription is provisioned. |
|
status
|
The status of the subscription. This field is not available for Enterprise Agreement billing accounts. Known values are: "Other", "Unknown", "Active", "Disabled", "Deleted", "Warned", "Expiring", "Expired", "AutoRenew", "Cancelled", "Suspended", and "Failed". |
|
operation_status
|
The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details. Known values are: "Other", "None", and "LockedForUpdate". |
|
provisioning_state
|
The provisioning state of the resource during a long-running operation. Known values are: "Succeeded", "Canceled", "Failed", "New", "Pending", "Provisioning", "PendingBilling", "ConfirmedBilling", "Creating", "Created", and "Expired". |
|
subscription_id
|
The ID of the subscription. |
|
suspension_reasons
|
The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts. |
|
suspension_reason_details
|
The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts. |
Attributes
auto_renew
"Off" and "On".
auto_renew: str | _models.AutoRenew | None
beneficiary
The beneficiary of the billing subscription.
beneficiary: _models.Beneficiary | None
beneficiary_tenant_id
The provisioning tenant of the subscription.
beneficiary_tenant_id: str | None
billing_frequency
P1M, P3M, P1Y.
billing_frequency: str | None
billing_policies
Dictionary of billing policies associated with the subscription.
billing_policies: dict[str, str] | None
billing_profile_display_name
The name of the billing profile.
billing_profile_display_name: str | None
billing_profile_id
The fully qualified ID that uniquely identifies a billing profile.
billing_profile_id: str | None
billing_profile_name
The ID that uniquely identifies a billing profile.
billing_profile_name: str | None
consumption_cost_center
The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts.
consumption_cost_center: str | None
customer_display_name
The name of the customer.
customer_display_name: str | None
customer_id
The fully qualified ID that uniquely identifies a customer.
customer_id: str | None
customer_name
The ID that uniquely identifies a customer.
customer_name: str | None
display_name
The name of the billing subscription.
display_name: str | None
enrollment_account_display_name
The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.
enrollment_account_display_name: str | None
enrollment_account_id
The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.
enrollment_account_id: str | None
enrollment_account_subscription_details
Enrollment Account Subscription details. This field is available only for the Enterprise Agreement Type billing accounts.
enrollment_account_subscription_details: _models.EnrollmentAccountSubscriptionDetails | None
invoice_section_display_name
The name of the invoice section.
invoice_section_display_name: str | None
invoice_section_id
The fully qualified ID that uniquely identifies an invoice section.
invoice_section_id: str | None
invoice_section_name
The ID that uniquely identifies an invoice section.
invoice_section_name: str | None
last_month_charges
The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.
last_month_charges: _models.Amount | None
month_to_date_charges
The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.
month_to_date_charges: _models.Amount | None
next_billing_cycle_details
Next billing cycle details of the subscription.
next_billing_cycle_details: _models.NextBillingCycleDetails | None
offer_id
The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement.
offer_id: str | None
operation_status
The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details. Known values are: "Other", "None", and "LockedForUpdate".
operation_status: str | _models.BillingSubscriptionOperationStatus | None
product_category
The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other.
product_category: str | None
product_type
Type of the product for which the subscription is purchased.
product_type: str | None
product_type_id
Id of the product for which the subscription is purchased.
product_type_id: str | None
provisioning_state
The provisioning state of the resource during a long-running operation. Known values are: "Succeeded", "Canceled", "Failed", "New", "Pending", "Provisioning", "PendingBilling", "ConfirmedBilling", "Creating", "Created", and "Expired".
provisioning_state: str | _models.ProvisioningState | None
provisioning_tenant_id
The tenant in which the subscription is provisioned.
provisioning_tenant_id: str | None
purchase_date
Purchase date of the product in UTC time.
purchase_date: datetime | None
quantity
The quantity of licenses or fulfillment units for the subscription.
quantity: int | None
renewal_term_details
Details for the next renewal term of a subscription.
renewal_term_details: _models.RenewalTermDetails | None
reseller
Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts.
reseller: _models.Reseller | None
resource_uri
Unique identifier of the linked resource.
resource_uri: str | None
sku_description
The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.
sku_description: str | None
sku_id
The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts.
sku_id: str | None
status
The status of the subscription. This field is not available for Enterprise Agreement billing accounts. Known values are: "Other", "Unknown", "Active", "Disabled", "Deleted", "Warned", "Expiring", "Expired", "AutoRenew", "Cancelled", "Suspended", and "Failed".
status: str | _models.BillingSubscriptionStatus | None
subscription_id
The ID of the subscription.
subscription_id: str | None
suspension_reason_details
The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts.
suspension_reason_details: list['_models.BillingSubscriptionStatusDetails'] | None
suspension_reasons
The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts.
suspension_reasons: list[str] | None
system_overrides
System imposed policies that regulate behavior of the subscription.
system_overrides: _models.SystemOverrides | None
term_duration
P1M, P3M, P1Y.
term_duration: str | None
term_end_date
End date of the term in UTC time.
term_end_date: datetime | None
term_start_date
Start date of the term in UTC time.
term_start_date: datetime | None