BillingSubscriptionInner Class

Package:

com.azure.resourcemanager.billing.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-billing:1.0.0

• java.lang.Object
• • com.azure.core.management.ProxyResource
  • • com.azure.resourcemanager.billing.models.ProxyResourceWithTags
    • • com.azure.resourcemanager.billing.fluent.models.BillingSubscriptionInner

public final class BillingSubscriptionInner
extends ProxyResourceWithTags

The billing properties of a subscription.

Constructor Summary

Constructor	Description
BillingSubscriptionInner()	Creates an instance of BillingSubscriptionInner class.

Method Summary

Modifier and Type	Method and Description
AutoRenew	autoRenew() Get the autoRenew property: Indicates whether auto renewal is turned on or off for a product.
Beneficiary	beneficiary() Get the beneficiary property: The beneficiary of the billing subscription.
String	beneficiaryTenantId() Get the beneficiaryTenantId property: The provisioning tenant of the subscription.
String	billingFrequency() Get the billingFrequency property: The billing frequency in ISO8601 format of product in the subscription.
Map<String,String>	billingPolicies() Get the billingPolicies property: Dictionary of billing policies associated with the subscription.
String	billingProfileDisplayName() Get the billingProfileDisplayName property: The name of the billing profile.
String	billingProfileId() Get the billingProfileId property: The fully qualified ID that uniquely identifies a billing profile.
String	billingProfileName() Get the billingProfileName property: The ID that uniquely identifies a billing profile.
String	consumptionCostCenter() Get the consumptionCostCenter property: The cost center applied to the subscription.
String	customerDisplayName() Get the customerDisplayName property: The name of the customer.
String	customerId() Get the customerId property: The fully qualified ID that uniquely identifies a customer.
String	customerName() Get the customerName property: The ID that uniquely identifies a customer.
String	displayName() Get the displayName property: The name of the billing subscription.
String	enrollmentAccountDisplayName() Get the enrollmentAccountDisplayName property: The enrollment Account name associated with the subscription.
String	enrollmentAccountId() Get the enrollmentAccountId property: The enrollment Account ID associated with the subscription.
OffsetDateTime	enrollmentAccountStartDate() Get the enrollmentAccountStartDate property: The enrollment Account and the subscription association start date.
static BillingSubscriptionInner	fromJson(JsonReader jsonReader) Reads an instance of BillingSubscriptionInner from the JsonReader.
String	id() Get the id property: Fully qualified resource Id for the resource.
String	invoiceSectionDisplayName() Get the invoiceSectionDisplayName property: The name of the invoice section.
String	invoiceSectionId() Get the invoiceSectionId property: The fully qualified ID that uniquely identifies an invoice section.
String	invoiceSectionName() Get the invoiceSectionName property: The ID that uniquely identifies an invoice section.
Amount	lastMonthCharges() Get the lastMonthCharges property: The last month's charges.
Amount	monthToDateCharges() Get the monthToDateCharges property: The current month to date charges.
String	name() Get the name property: The name of the resource.
NextBillingCycleDetails	nextBillingCycleDetails() Get the nextBillingCycleDetails property: Next billing cycle details of the subscription.
String	offerId() Get the offerId property: The offer ID for the subscription.
BillingSubscriptionOperationStatus	operationStatus() Get the operationStatus property: The status of an operation on the subscription.
String	productCategory() Get the productCategory property: The category of the product for which the subscription is purchased.
String	productType() Get the productType property: Type of the product for which the subscription is purchased.
String	productTypeId() Get the productTypeId property: Id of the product for which the subscription is purchased.
ProvisioningState	provisioningState() Get the provisioningState property: The provisioning state of the resource during a long-running operation.
String	provisioningTenantId() Get the provisioningTenantId property: The tenant in which the subscription is provisioned.
OffsetDateTime	purchaseDate() Get the purchaseDate property: Purchase date of the product in UTC time.
Long	quantity() Get the quantity property: The quantity of licenses or fulfillment units for the subscription.
RenewalTermDetails	renewalTermDetails() Get the renewalTermDetails property: Details for the next renewal term of a subscription.
Reseller	reseller() Get the reseller property: Reseller for this subscription.
String	resourceUri() Get the resourceUri property: Unique identifier of the linked resource.
String	skuDescription() Get the skuDescription property: The SKU description of the product for which the subscription is purchased.
String	skuId() Get the skuId property: The SKU ID of the product for which the subscription is purchased.
BillingSubscriptionStatus	status() Get the status property: The status of the subscription.
SubscriptionEnrollmentAccountStatus	subscriptionEnrollmentAccountStatus() Get the subscriptionEnrollmentAccountStatus property: The current enrollment account status of the subscription.
String	subscriptionId() Get the subscriptionId property: The ID of the subscription.
List<BillingSubscriptionStatusDetails>	suspensionReasonDetails() Get the suspensionReasonDetails property: The suspension details for a subscription.
List<String>	suspensionReasons() Get the suspensionReasons property: The suspension reason for a subscription.
SystemData	systemData() Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
SystemOverrides	systemOverrides() Get the systemOverrides property: System imposed policies that regulate behavior of the subscription.
String	termDuration() Get the termDuration property: The duration in ISO8601 format for which you can use the subscription.
OffsetDateTime	termEndDate() Get the termEndDate property: End date of the term in UTC time.
OffsetDateTime	termStartDate() Get the termStartDate property: Start date of the term in UTC time.
JsonWriter	toJson(JsonWriter jsonWriter)
String	type() Get the type property: The type of the resource.
void	validate() Validates the instance.
BillingSubscriptionInner	withAutoRenew(AutoRenew autoRenew) Set the autoRenew property: Indicates whether auto renewal is turned on or off for a product.
BillingSubscriptionInner	withBeneficiary(Beneficiary beneficiary) Set the beneficiary property: The beneficiary of the billing subscription.
BillingSubscriptionInner	withBeneficiaryTenantId(String beneficiaryTenantId) Set the beneficiaryTenantId property: The provisioning tenant of the subscription.
BillingSubscriptionInner	withBillingFrequency(String billingFrequency) Set the billingFrequency property: The billing frequency in ISO8601 format of product in the subscription.
BillingSubscriptionInner	withBillingProfileId(String billingProfileId) Set the billingProfileId property: The fully qualified ID that uniquely identifies a billing profile.
BillingSubscriptionInner	withConsumptionCostCenter(String consumptionCostCenter) Set the consumptionCostCenter property: The cost center applied to the subscription.
BillingSubscriptionInner	withCustomerId(String customerId) Set the customerId property: The fully qualified ID that uniquely identifies a customer.
BillingSubscriptionInner	withDisplayName(String displayName) Set the displayName property: The name of the billing subscription.
BillingSubscriptionInner	withInvoiceSectionId(String invoiceSectionId) Set the invoiceSectionId property: The fully qualified ID that uniquely identifies an invoice section.
BillingSubscriptionInner	withProductTypeId(String productTypeId) Set the productTypeId property: Id of the product for which the subscription is purchased.
BillingSubscriptionInner	withProvisioningTenantId(String provisioningTenantId) Set the provisioningTenantId property: The tenant in which the subscription is provisioned.
BillingSubscriptionInner	withQuantity(Long quantity) Set the quantity property: The quantity of licenses or fulfillment units for the subscription.
BillingSubscriptionInner	withSkuId(String skuId) Set the skuId property: The SKU ID of the product for which the subscription is purchased.
BillingSubscriptionInner	withSystemOverrides(SystemOverrides systemOverrides) Set the systemOverrides property: System imposed policies that regulate behavior of the subscription.
BillingSubscriptionInner	withTags(Map<String,String> tags) Set the tags property: Dictionary of metadata associated with the resource.
BillingSubscriptionInner	withTermDuration(String termDuration) Set the termDuration property: The duration in ISO8601 format for which you can use the subscription.

Methods inherited from ProxyResourceWithTags

fromJson id name systemData tags toJson type validate withTags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

BillingSubscriptionInner

public BillingSubscriptionInner()

Creates an instance of BillingSubscriptionInner class.

Method Details

autoRenew

public AutoRenew autoRenew()

Get the autoRenew property: Indicates whether auto renewal is turned on or off for a product.

Returns:

the autoRenew value.

beneficiary

public Beneficiary beneficiary()

Get the beneficiary property: The beneficiary of the billing subscription.

Returns:

the beneficiary value.

beneficiaryTenantId

public String beneficiaryTenantId()

Get the beneficiaryTenantId property: The provisioning tenant of the subscription.

Returns:

the beneficiaryTenantId value.

billingFrequency

public String billingFrequency()

Get the billingFrequency property: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y.

Returns:

the billingFrequency value.

billingPolicies

public Map<String,String> billingPolicies()

Get the billingPolicies property: Dictionary of billing policies associated with the subscription.

Returns:

the billingPolicies value.

billingProfileDisplayName

public String billingProfileDisplayName()

Get the billingProfileDisplayName property: The name of the billing profile.

Returns:

the billingProfileDisplayName value.

billingProfileId

public String billingProfileId()

Get the billingProfileId property: The fully qualified ID that uniquely identifies a billing profile.

Returns:

the billingProfileId value.

billingProfileName

public String billingProfileName()

Get the billingProfileName property: The ID that uniquely identifies a billing profile.

Returns:

the billingProfileName value.

consumptionCostCenter

public String consumptionCostCenter()

Get the consumptionCostCenter property: 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.

Returns:

the consumptionCostCenter value.

customerDisplayName

public String customerDisplayName()

Get the customerDisplayName property: The name of the customer.

Returns:

the customerDisplayName value.

customerId

public String customerId()

Get the customerId property: The fully qualified ID that uniquely identifies a customer.

Returns:

the customerId value.

customerName

public String customerName()

Get the customerName property: The ID that uniquely identifies a customer.

Returns:

the customerName value.

displayName

public String displayName()

Get the displayName property: The name of the billing subscription.

Returns:

the displayName value.

enrollmentAccountDisplayName

public String enrollmentAccountDisplayName()

Get the enrollmentAccountDisplayName property: The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.

Returns:

the enrollmentAccountDisplayName value.

enrollmentAccountId

public String enrollmentAccountId()

Get the enrollmentAccountId property: The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.

Returns:

the enrollmentAccountId value.

enrollmentAccountStartDate

public OffsetDateTime enrollmentAccountStartDate()

Get the enrollmentAccountStartDate property: The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type.

Returns:

the enrollmentAccountStartDate value.

fromJson

public static BillingSubscriptionInner fromJson(JsonReader jsonReader)

Reads an instance of BillingSubscriptionInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of BillingSubscriptionInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

BillingSubscriptionInner.id()

Returns:

the id value.

invoiceSectionDisplayName

public String invoiceSectionDisplayName()

Get the invoiceSectionDisplayName property: The name of the invoice section.

Returns:

the invoiceSectionDisplayName value.

invoiceSectionId

public String invoiceSectionId()

Get the invoiceSectionId property: The fully qualified ID that uniquely identifies an invoice section.

Returns:

the invoiceSectionId value.

invoiceSectionName

public String invoiceSectionName()

Get the invoiceSectionName property: The ID that uniquely identifies an invoice section.

Returns:

the invoiceSectionName value.

lastMonthCharges

public Amount lastMonthCharges()

Get the lastMonthCharges property: The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.

Returns:

the lastMonthCharges value.

monthToDateCharges

public Amount monthToDateCharges()

Get the monthToDateCharges property: The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.

Returns:

the monthToDateCharges value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

BillingSubscriptionInner.name()

Returns:

the name value.

nextBillingCycleDetails

public NextBillingCycleDetails nextBillingCycleDetails()

Get the nextBillingCycleDetails property: Next billing cycle details of the subscription.

Returns:

the nextBillingCycleDetails value.

offerId

public String offerId()

Get the offerId property: The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts.

Returns:

the offerId value.

operationStatus

public BillingSubscriptionOperationStatus operationStatus()

Get the operationStatus property: 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.

Returns:

the operationStatus value.

productCategory

public String productCategory()

Get the productCategory property: The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other.

Returns:

the productCategory value.

productType

public String productType()

Get the productType property: Type of the product for which the subscription is purchased.

Returns:

the productType value.

productTypeId

public String productTypeId()

Get the productTypeId property: Id of the product for which the subscription is purchased.

Returns:

the productTypeId value.

provisioningState

public ProvisioningState provisioningState()

Get the provisioningState property: The provisioning state of the resource during a long-running operation.

Returns:

the provisioningState value.

provisioningTenantId

public String provisioningTenantId()

Get the provisioningTenantId property: The tenant in which the subscription is provisioned.

Returns:

the provisioningTenantId value.

purchaseDate

public OffsetDateTime purchaseDate()

Get the purchaseDate property: Purchase date of the product in UTC time.

Returns:

the purchaseDate value.

quantity

public Long quantity()

Get the quantity property: The quantity of licenses or fulfillment units for the subscription.

Returns:

the quantity value.

renewalTermDetails

public RenewalTermDetails renewalTermDetails()

Get the renewalTermDetails property: Details for the next renewal term of a subscription.

Returns:

the renewalTermDetails value.

reseller

public Reseller reseller()

Get the reseller property: Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts.

Returns:

the reseller value.

resourceUri

public String resourceUri()

Get the resourceUri property: Unique identifier of the linked resource.

Returns:

the resourceUri value.

skuDescription

public String skuDescription()

Get the skuDescription property: 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.

Returns:

the skuDescription value.

skuId

public String skuId()

Get the skuId property: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts.

Returns:

the skuId value.

status

public BillingSubscriptionStatus status()

Get the status property: The status of the subscription. This field is not available for Enterprise Agreement billing accounts.

Returns:

the status value.

subscriptionEnrollmentAccountStatus

public SubscriptionEnrollmentAccountStatus subscriptionEnrollmentAccountStatus()

Get the subscriptionEnrollmentAccountStatus property: The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type.

Returns:

the subscriptionEnrollmentAccountStatus value.

subscriptionId

public String subscriptionId()

Get the subscriptionId property: The ID of the subscription.

Returns:

the subscriptionId value.

suspensionReasonDetails

public List<BillingSubscriptionStatusDetails> suspensionReasonDetails()

Get the suspensionReasonDetails property: The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts.

Returns:

the suspensionReasonDetails value.

suspensionReasons

public List<String> suspensionReasons()

Get the suspensionReasons property: The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts.

Returns:

the suspensionReasons value.

systemData

public SystemData systemData()

Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.

Overrides:

BillingSubscriptionInner.systemData()

Returns:

the systemData value.

systemOverrides

public SystemOverrides systemOverrides()

Get the systemOverrides property: System imposed policies that regulate behavior of the subscription.

Returns:

the systemOverrides value.

termDuration

public String termDuration()

Get the termDuration property: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y.

Returns:

the termDuration value.

termEndDate

public OffsetDateTime termEndDate()

Get the termEndDate property: End date of the term in UTC time.

Returns:

the termEndDate value.

termStartDate

public OffsetDateTime termStartDate()

Get the termStartDate property: Start date of the term in UTC time.

Returns:

the termStartDate value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

BillingSubscriptionInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public String type()

Get the type property: The type of the resource.

Overrides:

BillingSubscriptionInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

BillingSubscriptionInner.validate()

withAutoRenew

public BillingSubscriptionInner withAutoRenew(AutoRenew autoRenew)

Set the autoRenew property: Indicates whether auto renewal is turned on or off for a product.

Parameters:

autoRenew - the autoRenew value to set.

Returns:

the BillingSubscriptionInner object itself.

withBeneficiary

public BillingSubscriptionInner withBeneficiary(Beneficiary beneficiary)

Set the beneficiary property: The beneficiary of the billing subscription.

Parameters:

beneficiary - the beneficiary value to set.

Returns:

the BillingSubscriptionInner object itself.

withBeneficiaryTenantId

public BillingSubscriptionInner withBeneficiaryTenantId(String beneficiaryTenantId)

Set the beneficiaryTenantId property: The provisioning tenant of the subscription.

Parameters:

beneficiaryTenantId - the beneficiaryTenantId value to set.

Returns:

the BillingSubscriptionInner object itself.

withBillingFrequency

public BillingSubscriptionInner withBillingFrequency(String billingFrequency)

Set the billingFrequency property: The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y.

Parameters:

billingFrequency - the billingFrequency value to set.

Returns:

the BillingSubscriptionInner object itself.

withBillingProfileId

public BillingSubscriptionInner withBillingProfileId(String billingProfileId)

Set the billingProfileId property: The fully qualified ID that uniquely identifies a billing profile.

Parameters:

billingProfileId - the billingProfileId value to set.

Returns:

the BillingSubscriptionInner object itself.

withConsumptionCostCenter

public BillingSubscriptionInner withConsumptionCostCenter(String consumptionCostCenter)

Set the consumptionCostCenter property: 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.

Parameters:

consumptionCostCenter - the consumptionCostCenter value to set.

Returns:

the BillingSubscriptionInner object itself.

withCustomerId

public BillingSubscriptionInner withCustomerId(String customerId)

Set the customerId property: The fully qualified ID that uniquely identifies a customer.

Parameters:

customerId - the customerId value to set.

Returns:

the BillingSubscriptionInner object itself.

withDisplayName

public BillingSubscriptionInner withDisplayName(String displayName)

Set the displayName property: The name of the billing subscription.

Parameters:

displayName - the displayName value to set.

Returns:

the BillingSubscriptionInner object itself.

withInvoiceSectionId

public BillingSubscriptionInner withInvoiceSectionId(String invoiceSectionId)

Set the invoiceSectionId property: The fully qualified ID that uniquely identifies an invoice section.

Parameters:

invoiceSectionId - the invoiceSectionId value to set.

Returns:

the BillingSubscriptionInner object itself.

withProductTypeId

public BillingSubscriptionInner withProductTypeId(String productTypeId)

Set the productTypeId property: Id of the product for which the subscription is purchased.

Parameters:

productTypeId - the productTypeId value to set.

Returns:

the BillingSubscriptionInner object itself.

withProvisioningTenantId

public BillingSubscriptionInner withProvisioningTenantId(String provisioningTenantId)

Set the provisioningTenantId property: The tenant in which the subscription is provisioned.

Parameters:

provisioningTenantId - the provisioningTenantId value to set.

Returns:

the BillingSubscriptionInner object itself.

withQuantity

public BillingSubscriptionInner withQuantity(Long quantity)

Set the quantity property: The quantity of licenses or fulfillment units for the subscription.

Parameters:

quantity - the quantity value to set.

Returns:

the BillingSubscriptionInner object itself.

withSkuId

public BillingSubscriptionInner withSkuId(String skuId)

Set the skuId property: The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts.

Parameters:

skuId - the skuId value to set.

Returns:

the BillingSubscriptionInner object itself.

withSystemOverrides

public BillingSubscriptionInner withSystemOverrides(SystemOverrides systemOverrides)

Set the systemOverrides property: System imposed policies that regulate behavior of the subscription.

Parameters:

systemOverrides - the systemOverrides value to set.

Returns:

the BillingSubscriptionInner object itself.

withTags

public BillingSubscriptionInner withTags(Map<String,String> tags)

Set the tags property: Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /.

Overrides:

BillingSubscriptionInner.withTags(Map<String,String> tags)

Parameters:

tags

withTermDuration

public BillingSubscriptionInner withTermDuration(String termDuration)

Set the termDuration property: The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y.

Parameters:

termDuration - the termDuration value to set.

Returns:

the BillingSubscriptionInner object itself.