@azure/arm-billing package

Interfaces

AcceptTransferProperties

Request parameters to accept transfer.

AcceptTransferRequest

Request parameters to accept transfer.

AddressDetails

Address details.

AddressOperations

Interface representing a Address operations.

AddressValidateOptionalParams

Optional parameters.

AddressValidationResponse

Result of the address validation.

Agreement

An agreement.

AgreementProperties

An agreement.

AgreementsGetOptionalParams

Optional parameters.

AgreementsListByBillingAccountOptionalParams

Optional parameters.

AgreementsOperations

Interface representing a Agreements operations.

Amount

The amount.

AppliedScopeProperties

Properties specific to applied scope type. Not required if not applicable.

AssociatedTenant

An associated tenant.

AssociatedTenantProperties

An associated tenant.

AssociatedTenantsCreateOrUpdateOptionalParams

Optional parameters.

AssociatedTenantsDeleteOptionalParams

Optional parameters.

AssociatedTenantsGetOptionalParams

Optional parameters.

AssociatedTenantsListByBillingAccountOptionalParams

Optional parameters.

AssociatedTenantsOperations

Interface representing a AssociatedTenants operations.

AvailableBalance

The Available Credit or Payment on Account Balance. The credit balance can be used to settle due or past due invoices.

AvailableBalanceProperties

The Available Credit or Payment on Account Balance. The credit balance can be used to settle due or past due invoices.

AvailableBalancePropertiesAmount

Credit amount for immediate payment.

AvailableBalancePropertiesTotalPaymentsOnAccount

Total amount of payments on accounts.

AvailableBalancesGetByBillingAccountOptionalParams

Optional parameters.

AvailableBalancesGetByBillingProfileOptionalParams

Optional parameters.

AvailableBalancesOperations

Interface representing a AvailableBalances operations.

AzurePlan

Details of the Azure plan.

Beneficiary

Details of the beneficiary.

BillingAccount

A billing account.

BillingAccountPatch

A billing account.

BillingAccountPolicy

A policy at billing account scope.

BillingAccountPolicyProperties

A policy at billing account scope.

BillingAccountPolicyPropertiesEnterpriseAgreementPolicies

The policies for Enterprise Agreement enrollments.

BillingAccountProperties

A billing account.

BillingAccountPropertiesEnrollmentDetails

The properties of an enrollment.

BillingAccountPropertiesRegistrationNumber

Describes the registration number of the organization linked with the billing account.

BillingAccountPropertiesSoldTo

The address of the individual or organization that is responsible for the billing account.

BillingAccountsAddPaymentTermsOptionalParams

Optional parameters.

BillingAccountsCancelPaymentTermsOptionalParams

Optional parameters.

BillingAccountsConfirmTransitionOptionalParams

Optional parameters.

BillingAccountsGetOptionalParams

Optional parameters.

BillingAccountsListInvoiceSectionsByCreateSubscriptionPermissionOptionalParams

Optional parameters.

BillingAccountsListOptionalParams

Optional parameters.

BillingAccountsOperations

Interface representing a BillingAccounts operations.

BillingAccountsUpdateOptionalParams

Optional parameters.

BillingAccountsValidatePaymentTermsOptionalParams

Optional parameters.

BillingManagementClientOptionalParams

Optional parameters for the client.

BillingPermission

The set of allowed action and not allowed actions a caller has on a resource.

BillingPermissionsCheckAccessByBillingAccountOptionalParams

Optional parameters.

BillingPermissionsCheckAccessByBillingProfileOptionalParams

Optional parameters.

BillingPermissionsCheckAccessByCustomerOptionalParams

Optional parameters.

BillingPermissionsCheckAccessByDepartmentOptionalParams

Optional parameters.

BillingPermissionsCheckAccessByEnrollmentAccountOptionalParams

Optional parameters.

BillingPermissionsCheckAccessByInvoiceSectionOptionalParams

Optional parameters.

BillingPermissionsListByBillingAccountOptionalParams

Optional parameters.

BillingPermissionsListByBillingProfileOptionalParams

Optional parameters.

BillingPermissionsListByCustomerAtBillingAccountOptionalParams

Optional parameters.

BillingPermissionsListByCustomerOptionalParams

Optional parameters.

BillingPermissionsListByDepartmentOptionalParams

Optional parameters.

BillingPermissionsListByEnrollmentAccountOptionalParams

Optional parameters.

BillingPermissionsListByInvoiceSectionOptionalParams

Optional parameters.

BillingPermissionsOperations

Interface representing a BillingPermissions operations.

BillingPlanInformation

Information describing the type of billing plan for this savings plan.

BillingProfile

A billing profile.

BillingProfileInfo

Details about billing profile associated with agreement and available only for specific agreements.

BillingProfilePolicy

A policy at billing profile scope.

BillingProfilePolicyProperties

A policy at billing profile scope.

BillingProfilePolicyPropertiesEnterpriseAgreementPolicies

The policies for Enterprise Agreement enrollments.

BillingProfileProperties

A billing profile.

BillingProfilePropertiesBillTo

Billing address.

BillingProfilePropertiesCurrentPaymentTerm

The current payment term of the billing profile.

BillingProfilePropertiesIndirectRelationshipInfo

Identifies the billing profile that is linked to another billing profile in indirect purchase motion.

BillingProfilePropertiesShipTo

The default address where the products are shipped, or the services are being used. If a ship to is not specified for a product or a subscription, then this address will be used.

BillingProfilePropertiesSoldTo

The address of the individual or organization that is responsible for the billing account.

BillingProfilesCreateOrUpdateOptionalParams

Optional parameters.

BillingProfilesDeleteOptionalParams

Optional parameters.

BillingProfilesGetOptionalParams

Optional parameters.

BillingProfilesListByBillingAccountOptionalParams

Optional parameters.

BillingProfilesOperations

Interface representing a BillingProfiles operations.

BillingProfilesValidateDeleteEligibilityOptionalParams

Optional parameters.

BillingProperty

A billing property.

BillingPropertyGetOptionalParams

Optional parameters.

BillingPropertyOperations

Interface representing a BillingProperty operations.

BillingPropertyProperties

A billing property.

BillingPropertyPropertiesEnrollmentDetails

The enrollment details for the subscription. Available for billing accounts with agreement type Enterprise Agreement.

BillingPropertyPropertiesSubscriptionServiceUsageAddress

The address of the individual or organization where service subscription is being used. Available for agreement type Microsoft Online Services Program. This property can be updated via patch.

BillingPropertyUpdateOptionalParams

Optional parameters.

BillingRequest

A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests.

BillingRequestProperties

A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests.

BillingRequestPropertiesCreatedBy

The principal of the entity who created the request.

BillingRequestPropertiesLastUpdatedBy

The principal of the entity who last updated the request.

BillingRequestPropertiesReviewedBy

The principal of the request reviewer. Will only be set if request is approved.

BillingRequestsCreateOrUpdateOptionalParams

Optional parameters.

BillingRequestsGetOptionalParams

Optional parameters.

BillingRequestsListByBillingAccountOptionalParams

Optional parameters.

BillingRequestsListByBillingProfileOptionalParams

Optional parameters.

BillingRequestsListByCustomerOptionalParams

Optional parameters.

BillingRequestsListByInvoiceSectionOptionalParams

Optional parameters.

BillingRequestsListByUserOptionalParams

Optional parameters.

BillingRequestsOperations

Interface representing a BillingRequests operations.

BillingRoleAssignment

The properties of the billing role assignment.

BillingRoleAssignmentListResult

Paged collection of BillingRoleAssignment items

BillingRoleAssignmentProperties

The properties of the billing role assignment.

BillingRoleAssignmentsCreateByBillingAccountOptionalParams

Optional parameters.

BillingRoleAssignmentsCreateByBillingProfileOptionalParams

Optional parameters.

BillingRoleAssignmentsCreateByCustomerOptionalParams

Optional parameters.

BillingRoleAssignmentsCreateByInvoiceSectionOptionalParams

Optional parameters.

BillingRoleAssignmentsCreateOrUpdateByBillingAccountOptionalParams

Optional parameters.

BillingRoleAssignmentsCreateOrUpdateByDepartmentOptionalParams

Optional parameters.

BillingRoleAssignmentsCreateOrUpdateByEnrollmentAccountOptionalParams

Optional parameters.

BillingRoleAssignmentsDeleteByBillingAccountOptionalParams

Optional parameters.

BillingRoleAssignmentsDeleteByBillingProfileOptionalParams

Optional parameters.

BillingRoleAssignmentsDeleteByCustomerOptionalParams

Optional parameters.

BillingRoleAssignmentsDeleteByDepartmentOptionalParams

Optional parameters.

BillingRoleAssignmentsDeleteByEnrollmentAccountOptionalParams

Optional parameters.

BillingRoleAssignmentsDeleteByInvoiceSectionOptionalParams

Optional parameters.

BillingRoleAssignmentsGetByBillingAccountOptionalParams

Optional parameters.

BillingRoleAssignmentsGetByBillingProfileOptionalParams

Optional parameters.

BillingRoleAssignmentsGetByCustomerOptionalParams

Optional parameters.

BillingRoleAssignmentsGetByDepartmentOptionalParams

Optional parameters.

BillingRoleAssignmentsGetByEnrollmentAccountOptionalParams

Optional parameters.

BillingRoleAssignmentsGetByInvoiceSectionOptionalParams

Optional parameters.

BillingRoleAssignmentsListByBillingAccountOptionalParams

Optional parameters.

BillingRoleAssignmentsListByBillingProfileOptionalParams

Optional parameters.

BillingRoleAssignmentsListByCustomerOptionalParams

Optional parameters.

BillingRoleAssignmentsListByDepartmentOptionalParams

Optional parameters.

BillingRoleAssignmentsListByEnrollmentAccountOptionalParams

Optional parameters.

BillingRoleAssignmentsListByInvoiceSectionOptionalParams

Optional parameters.

BillingRoleAssignmentsOperations

Interface representing a BillingRoleAssignments operations.

BillingRoleAssignmentsResolveByBillingAccountOptionalParams

Optional parameters.

BillingRoleAssignmentsResolveByBillingProfileOptionalParams

Optional parameters.

BillingRoleAssignmentsResolveByCustomerOptionalParams

Optional parameters.

BillingRoleAssignmentsResolveByInvoiceSectionOptionalParams

Optional parameters.

BillingRoleDefinition

The properties of a role definition.

BillingRoleDefinitionGetByBillingAccountOptionalParams

Optional parameters.

BillingRoleDefinitionGetByBillingProfileOptionalParams

Optional parameters.

BillingRoleDefinitionGetByCustomerOptionalParams

Optional parameters.

BillingRoleDefinitionGetByDepartmentOptionalParams

Optional parameters.

BillingRoleDefinitionGetByEnrollmentAccountOptionalParams

Optional parameters.

BillingRoleDefinitionGetByInvoiceSectionOptionalParams

Optional parameters.

BillingRoleDefinitionListByBillingAccountOptionalParams

Optional parameters.

BillingRoleDefinitionListByBillingProfileOptionalParams

Optional parameters.

BillingRoleDefinitionListByCustomerOptionalParams

Optional parameters.

BillingRoleDefinitionListByDepartmentOptionalParams

Optional parameters.

BillingRoleDefinitionListByEnrollmentAccountOptionalParams

Optional parameters.

BillingRoleDefinitionListByInvoiceSectionOptionalParams

Optional parameters.

BillingRoleDefinitionOperations

Interface representing a BillingRoleDefinition operations.

BillingRoleDefinitionProperties

The properties of a role definition.

BillingSubscription

The billing properties of a subscription.

BillingSubscriptionAlias

A billing subscription alias.

BillingSubscriptionAliasProperties

A billing subscription alias.

BillingSubscriptionMergeRequest

Request parameters that are provided to merge the two billing subscriptions.

BillingSubscriptionPatch

The billing properties of a subscription.

BillingSubscriptionProperties

The billing properties of a subscription.

BillingSubscriptionSplitRequest

Request parameters that are provided to split the billing subscription.

BillingSubscriptionStatusDetails

The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts.

BillingSubscriptionsAliasesCreateOrUpdateOptionalParams

Optional parameters.

BillingSubscriptionsAliasesGetOptionalParams

Optional parameters.

BillingSubscriptionsAliasesListByBillingAccountOptionalParams

Optional parameters.

BillingSubscriptionsAliasesOperations

Interface representing a BillingSubscriptionsAliases operations.

BillingSubscriptionsCancelOptionalParams

Optional parameters.

BillingSubscriptionsDeleteOptionalParams

Optional parameters.

BillingSubscriptionsGetByBillingProfileOptionalParams

Optional parameters.

BillingSubscriptionsGetOptionalParams

Optional parameters.

BillingSubscriptionsListByBillingAccountOptionalParams

Optional parameters.

BillingSubscriptionsListByBillingProfileOptionalParams

Optional parameters.

BillingSubscriptionsListByCustomerAtBillingAccountOptionalParams

Optional parameters.

BillingSubscriptionsListByCustomerOptionalParams

Optional parameters.

BillingSubscriptionsListByEnrollmentAccountOptionalParams

Optional parameters.

BillingSubscriptionsListByInvoiceSectionOptionalParams

Optional parameters.

BillingSubscriptionsMergeOptionalParams

Optional parameters.

BillingSubscriptionsMoveOptionalParams

Optional parameters.

BillingSubscriptionsOperations

Interface representing a BillingSubscriptions operations.

BillingSubscriptionsSplitOptionalParams

Optional parameters.

BillingSubscriptionsUpdateOptionalParams

Optional parameters.

BillingSubscriptionsValidateMoveEligibilityOptionalParams

Optional parameters.

CancelSubscriptionRequest

Request parameters for cancel customer subscription.

CheckAccessRequest

Request to check access.

CheckAccessResponse

The properties of a check access response.

Commitment

Commitment towards the benefit.

Customer

A partner's customer.

CustomerPolicy

A policy at customer scope.

CustomerPolicyProperties

A policy at customer scope.

CustomerProperties

A partner's customer.

CustomersGetByBillingAccountOptionalParams

Optional parameters.

CustomersGetOptionalParams

Optional parameters.

CustomersListByBillingAccountOptionalParams

Optional parameters.

CustomersListByBillingProfileOptionalParams

Optional parameters.

CustomersOperations

Interface representing a Customers operations.

DeleteBillingProfileEligibilityDetail

Validation details of delete billing profile eligibility.

DeleteBillingProfileEligibilityResult

Eligibility to delete a billing profile result.

DeleteInvoiceSectionEligibilityDetail

The details of delete invoice section eligibility result.

DeleteInvoiceSectionEligibilityResult

Eligibility to delete an invoice section result.

Department

Optional grouping of enrollment accounts to segment costs into logical groupings and set budgets.

DepartmentProperties

Optional grouping of enrollment accounts to segment costs into logical groupings and set budgets.

DepartmentsGetOptionalParams

Optional parameters.

DepartmentsListByBillingAccountOptionalParams

Optional parameters.

DepartmentsOperations

Interface representing a Departments operations.

DetailedTransferStatus

Detailed transfer status.

DocumentDownloadRequest

A list of download details for individual documents.

DocumentDownloadResult

A secure URL that can be used to download a an entity until the URL expires.

EnrollmentAccount

It is an organizational hierarchy within a billing account to administer and manage azure costs.

EnrollmentAccountProperties

It is an organizational hierarchy within a billing account to administer and manage azure costs.

EnrollmentAccountSubscriptionDetails

The billing properties that can be modified. Available only for the Enterprise Agreement Type.

EnrollmentAccountsGetByDepartmentOptionalParams

Optional parameters.

EnrollmentAccountsGetOptionalParams

Optional parameters.

EnrollmentAccountsListByBillingAccountOptionalParams

Optional parameters.

EnrollmentAccountsListByDepartmentOptionalParams

Optional parameters.

EnrollmentAccountsOperations

Interface representing a EnrollmentAccounts operations.

EnrollmentDetails

The properties of an enrollment.

EnrollmentDetailsIndirectRelationshipInfo

The properties of an enrollment which are applicable only for indirect enrollments.

EnterpriseAgreementPolicies

The policies for Enterprise Agreement enrollments.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Common error response for all Azure Resource Manager APIs to return error details for failed operations.

ExtendedStatusDefinitionProperties

Extended status definition properties

ExtendedStatusInfo

Extended status information

ExtendedStatusInfoProperties

Properties specific to credit line check failure

FailedPayment

A failed payment.

IndirectRelationshipInfo

Identifies the billing profile that is linked to another billing profile in indirect purchase motion.

InitiateTransferProperties

Request parameters to initiate transfer.

InitiateTransferRequest

Request parameters to initiate transfer.

Invoice

An invoice.

InvoiceDocument

The properties of a document.

InvoiceProperties

An invoice.

InvoicePropertiesAmountDue

The amount due as of now.

InvoicePropertiesAzurePrepaymentApplied

The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.

InvoicePropertiesBilledAmount

The total charges for the invoice billing period.

InvoicePropertiesCreditAmount

The total refund for returns and cancellations during the invoice billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.

InvoicePropertiesFreeAzureCreditApplied

The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.

InvoicePropertiesRebillDetails

Rebill details for an invoice.

InvoicePropertiesRefundDetails

The details of a refund request.

InvoicePropertiesSubTotal

The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.

InvoicePropertiesTaxAmount

The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.

InvoicePropertiesTotalAmount

The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.

InvoiceSection

An invoice section.

InvoiceSectionProperties

An invoice section.

InvoiceSectionWithCreateSubPermission

Invoice section properties with create subscription permission.

InvoiceSectionsCreateOrUpdateOptionalParams

Optional parameters.

InvoiceSectionsDeleteOptionalParams

Optional parameters.

InvoiceSectionsGetOptionalParams

Optional parameters.

InvoiceSectionsListByBillingProfileOptionalParams

Optional parameters.

InvoiceSectionsOperations

Interface representing a InvoiceSections operations.

InvoiceSectionsValidateDeleteEligibilityOptionalParams

Optional parameters.

InvoicesAmendOptionalParams

Optional parameters.

InvoicesDownloadByBillingAccountOptionalParams

Optional parameters.

InvoicesDownloadByBillingSubscriptionOptionalParams

Optional parameters.

InvoicesDownloadDocumentsByBillingAccountOptionalParams

Optional parameters.

InvoicesDownloadDocumentsByBillingSubscriptionOptionalParams

Optional parameters.

InvoicesDownloadSummaryByBillingAccountOptionalParams

Optional parameters.

InvoicesGetByBillingAccountOptionalParams

Optional parameters.

InvoicesGetByBillingSubscriptionOptionalParams

Optional parameters.

InvoicesGetOptionalParams

Optional parameters.

InvoicesListByBillingAccountOptionalParams

Optional parameters.

InvoicesListByBillingProfileOptionalParams

Optional parameters.

InvoicesListByBillingSubscriptionOptionalParams

Optional parameters.

InvoicesOperations

Interface representing a Invoices operations.

MoveBillingSubscriptionEligibilityResult

Result of the transfer eligibility validation.

MoveBillingSubscriptionErrorDetails

Error details of the transfer eligibility validation.

MoveBillingSubscriptionRequest

Request parameters to transfer billing subscription.

MoveProductEligibilityResult

Result of the transfer eligibility validation.

MoveProductEligibilityResultErrorDetails

Error details of the transfer eligibility validation.

MoveProductErrorDetails

Error details of the transfer eligibility validation.

MoveProductRequest

The properties of the product to initiate a transfer.

NextBillingCycleDetails

Billing cycle details of the product.

Operation

Details of a REST API operation, returned from the Resource Provider Operations API.

OperationDisplay

Localized display information for this particular operation.

OperationsListOptionalParams

Optional parameters.

OperationsOperations

Interface representing a Operations operations.

PageSettings

Options for the byPage method

PagedAsyncIterableIterator

An interface that allows async iterable iteration both to completion and by page.

Participant

Billing account name. Available for a specific type of agreement.

PartnerInitiateTransferProperties

Request parameters to initiate transfer.

PartnerInitiateTransferRequest

Request parameters to initiate partner transfer.

PartnerTransferDetails

Details of the transfer.

PartnerTransferProperties

Transfer Details.

PartnerTransfersCancelOptionalParams

Optional parameters.

PartnerTransfersGetOptionalParams

Optional parameters.

PartnerTransfersInitiateOptionalParams

Optional parameters.

PartnerTransfersListOptionalParams

Optional parameters.

PartnerTransfersOperations

Interface representing a PartnerTransfers operations.

Patch

The request for reservation patch

PatchProperties

Properties for reservation patch

PatchPropertiesRenewProperties

model interface PatchPropertiesRenewProperties

Payment

An invoice payment.

PaymentAmount

The paid amount.

PaymentDetail

Information about payment related to a savings plan order.

PaymentMethod

A payment method.

PaymentMethodLink

A payment method link.

PaymentMethodLinkProperties

The properties of a payment method link.

PaymentMethodLogo

Logo of payment method.

PaymentMethodProperties

The properties of a payment method.

PaymentMethodsDeleteByUserOptionalParams

Optional parameters.

PaymentMethodsGetByBillingAccountOptionalParams

Optional parameters.

PaymentMethodsGetByBillingProfileOptionalParams

Optional parameters.

PaymentMethodsGetByUserOptionalParams

Optional parameters.

PaymentMethodsListByBillingAccountOptionalParams

Optional parameters.

PaymentMethodsListByBillingProfileOptionalParams

Optional parameters.

PaymentMethodsListByUserOptionalParams

Optional parameters.

PaymentMethodsOperations

Interface representing a PaymentMethods operations.

PaymentOnAccount

A Payment on Account.

PaymentOnAccountAmount

Payment on Account amount.

PaymentTerm

The properties of payment term.

PaymentTermsEligibilityDetail

Details of the payment terms eligibility.

PaymentTermsEligibilityResult

Result of the payment terms eligibility.

PoliciesCreateOrUpdateByBillingAccountOptionalParams

Optional parameters.

PoliciesCreateOrUpdateByBillingProfileOptionalParams

Optional parameters.

PoliciesCreateOrUpdateByCustomerAtBillingAccountOptionalParams

Optional parameters.

PoliciesCreateOrUpdateByCustomerOptionalParams

Optional parameters.

PoliciesGetByBillingAccountOptionalParams

Optional parameters.

PoliciesGetByBillingProfileOptionalParams

Optional parameters.

PoliciesGetByCustomerAtBillingAccountOptionalParams

Optional parameters.

PoliciesGetByCustomerOptionalParams

Optional parameters.

PoliciesGetBySubscriptionOptionalParams

Optional parameters.

PoliciesOperations

Interface representing a Policies operations.

PolicySummary

The summary of the policy.

Price

The price.

Principal

A principal who has interacted with a billing entity.

Product

A product.

ProductDetails

Details of the product that is transferred.

ProductPatch

A product.

ProductProperties

A product.

ProductPropertiesLastCharge

The last month charges.

ProductPropertiesReseller

Reseller for this product. The fields is not available for Microsoft Partner Agreement products.

ProductsGetOptionalParams

Optional parameters.

ProductsListByBillingAccountOptionalParams

Optional parameters.

ProductsListByBillingProfileOptionalParams

Optional parameters.

ProductsListByCustomerOptionalParams

Optional parameters.

ProductsListByInvoiceSectionOptionalParams

Optional parameters.

ProductsMoveOptionalParams

Optional parameters.

ProductsOperations

Interface representing a Products operations.

ProductsUpdateOptionalParams

Optional parameters.

ProductsValidateMoveEligibilityOptionalParams

Optional parameters.

ProxyResource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

ProxyResourceWithTags

Common fields that are returned in the response for all Azure Resource Manager resources.

PurchaseRequest

Purchase request.

PurchaseRequestProperties

Purchase request properties.

RebillDetails

The rebill details of an invoice.

RecipientTransferDetails

Details of the transfer.

RecipientTransferProperties

Transfer Details.

RecipientTransfersAcceptOptionalParams

Optional parameters.

RecipientTransfersDeclineOptionalParams

Optional parameters.

RecipientTransfersGetOptionalParams

Optional parameters.

RecipientTransfersListOptionalParams

Optional parameters.

RecipientTransfersOperations

Interface representing a RecipientTransfers operations.

RecipientTransfersValidateOptionalParams

Optional parameters.

RefundDetailsSummary

The details of refund request.

RefundDetailsSummaryAmountRefunded

The amount refunded.

RefundDetailsSummaryAmountRequested

The amount of refund requested.

RefundTransactionDetails

The refund details of a transaction.

RefundTransactionDetailsAmountRefunded

The amount refunded.

RefundTransactionDetailsAmountRequested

The amount of refund requested.

RegistrationNumber

Describes the registration number of the organization linked with the billing account.

RenewProperties

Properties specific to renew.

RenewPropertiesResponse

The renew properties for a reservation.

RenewalTermDetails

Details for the next renewal term of a subscription.

Reseller

Details of the reseller.

Reservation

The definition of the reservation.

ReservationAppliedScopeProperties

Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup

ReservationExtendedStatusInfo

Extended status information for the reservation.

ReservationMergeProperties

Properties of reservation merge

ReservationOrder

Details of a reservation order being returned.

ReservationOrderBillingPlanInformation

Information describing the type of billing plan for this reservation order.

ReservationOrderProperty

Properties of a reservation order.

ReservationOrdersGetByBillingAccountOptionalParams

Optional parameters.

ReservationOrdersListByBillingAccountOptionalParams

Optional parameters.

ReservationOrdersOperations

Interface representing a ReservationOrders operations.

ReservationPaymentDetail

Information about payment related to a reservation order.

ReservationProperty

The property of reservation object.

ReservationPropertyUtilization

Reservation utilization

ReservationPurchaseRequest

The request for reservation purchase

ReservationPurchaseRequestProperties

Properties of reservation purchase request

ReservationPurchaseRequestPropertiesReservedResourceProperties

Properties specific to each reserved resource type. Not required if not applicable.

ReservationSkuProperty

The property of reservation sku object.

ReservationSplitProperties

Properties of reservation split

ReservationSummary

The roll up count summary of reservations in each state

ReservationSwapProperties

Properties of reservation swap

ReservationUtilizationAggregates

The aggregate values of reservation utilization

ReservationsGetByReservationOrderOptionalParams

Optional parameters.

ReservationsListByBillingAccountOptionalParams

Optional parameters.

ReservationsListByBillingProfileOptionalParams

Optional parameters.

ReservationsListByReservationOrderOptionalParams

Optional parameters.

ReservationsOperations

Interface representing a Reservations operations.

ReservationsUpdateByBillingAccountOptionalParams

Optional parameters.

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

RestorePollerOptions
SavingsPlanModel

Savings plan

SavingsPlanModelProperties

Savings plan properties

SavingsPlanOrderModel

Savings plan order

SavingsPlanOrderModelProperties

Savings plan order properties

SavingsPlanOrdersGetByBillingAccountOptionalParams

Optional parameters.

SavingsPlanOrdersListByBillingAccountOptionalParams

Optional parameters.

SavingsPlanOrdersOperations

Interface representing a SavingsPlanOrders operations.

SavingsPlanSummaryCount

The roll up count summary of savings plans in each state

SavingsPlanUpdateRequest

Savings plan patch request

SavingsPlanUpdateRequestProperties

Savings plan patch request

SavingsPlanUpdateValidateRequest

Savings plan update validate request.

SavingsPlanValidResponseProperty

Benefit scope response property

SavingsPlanValidateResponse

Savings plan update validate response.

SavingsPlansGetByBillingAccountOptionalParams

Optional parameters.

SavingsPlansListByBillingAccountOptionalParams

Optional parameters.

SavingsPlansListBySavingsPlanOrderOptionalParams

Optional parameters.

SavingsPlansOperations

Interface representing a SavingsPlans operations.

SavingsPlansUpdateByBillingAccountOptionalParams

Optional parameters.

SavingsPlansValidateUpdateByBillingAccountOptionalParams

Optional parameters.

SimplePollerLike

A simple poller that can be used to poll a long running operation.

Sku

The SKU to be applied for this resource

SkuName

The name of sku

SpendingLimitDetails

The billing profile spending limit.

SubscriptionEnrollmentDetails

The enrollment details for the subscription. Available for billing accounts with agreement type Enterprise Agreement.

SubscriptionPolicy

A policy at subscription scope.

SubscriptionPolicyProperties

A policy at subscription scope.

SystemData

Metadata pertaining to creation and last modification of the resource.

SystemOverrides

System imposed policies that regulate behavior of the subscription.

TaxIdentifier

A tax identifier for the billing account.

Transaction

A transaction.

TransactionProperties

A transaction.

TransactionPropertiesAzureCreditApplied

The amount of any Azure credits automatically applied to this transaction.

TransactionPropertiesConsumptionCommitmentDecremented

The amount of Microsoft Azure Consumption Commitment(MACC) decrement through the transaction.

TransactionPropertiesEffectivePrice

The price of the product after applying any discounts.

TransactionPropertiesMarketPrice

The retail price of the product.

TransactionPropertiesRefundTransactionDetails

The refund details of a transaction.

TransactionPropertiesSubTotal

The pre-tax charged amount for the transaction.

TransactionPropertiesTax

The tax amount applied to the transaction.

TransactionPropertiesTransactionAmount

The charge associated with the transaction.

TransactionSummary

A transaction summary.

TransactionsGetTransactionSummaryByInvoiceOptionalParams

Optional parameters.

TransactionsListByBillingProfileOptionalParams

Optional parameters.

TransactionsListByCustomerOptionalParams

Optional parameters.

TransactionsListByInvoiceOptionalParams

Optional parameters.

TransactionsListByInvoiceSectionOptionalParams

Optional parameters.

TransactionsOperations

Interface representing a Transactions operations.

TransactionsTransactionsDownloadByInvoiceOptionalParams

Optional parameters.

TransferDetails

Details of the transfer.

TransferError

Error details for transfer execution.

TransferProperties

Transfer details

TransfersCancelOptionalParams

Optional parameters.

TransfersGetOptionalParams

Optional parameters.

TransfersInitiateOptionalParams

Optional parameters.

TransfersListOptionalParams

Optional parameters.

TransfersOperations

Interface representing a Transfers operations.

TransitionDetails

The details for a billing account transitioned from agreement type Microsoft Online Services Program to agreement type Microsoft Customer Agreement.

Utilization

Savings plan utilization

UtilizationAggregates

The aggregate values of savings plan utilization

ValidateTransferListResponse

Result of transfer validation.

ValidateTransferResponse

Transfer validation response.

ValidateTransferResponseProperties

The properties of transfer validation response.

ValidationResultProperties

The properties of the validation result.

Type Aliases

AcceptanceMode

The mode of acceptance for an agreement.
KnownAcceptanceMode can be used interchangeably with AcceptanceMode, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
ClickToAccept: ClickToAccept
ESignEmbedded: ESignEmbedded
ESignOffline: ESignOffline
Implicit: Implicit
Offline: Offline
PhysicalSign: PhysicalSign

AccessDecision

Access Decision, specifies access is allowed or not.
KnownAccessDecision can be used interchangeably with AccessDecision, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
Allowed: Allowed
NotAllowed: NotAllowed

AccountStatus

The current status of the billing account.
KnownAccountStatus can be used interchangeably with AccountStatus, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
Active: Active
UnderReview: UnderReview
Disabled: Disabled
Deleted: Deleted
Extended: Extended
Pending: Pending
New: New
Expired: Expired
Terminated: Terminated
Transferred: Transferred

AccountSubType

The tier of the account.
KnownAccountSubType can be used interchangeably with AccountSubType, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
None: None
Individual: Individual
Professional: Professional
Enterprise: Enterprise

AccountType

The type of customer.
KnownAccountType can be used interchangeably with AccountType, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
Enterprise: Enterprise
Individual: Individual
Partner: Partner
Reseller: Reseller
ClassicPartner: ClassicPartner
Internal: Internal
Tenant: Tenant
Business: Business

AddressValidationStatus

Status of the address validation.
KnownAddressValidationStatus can be used interchangeably with AddressValidationStatus, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
Valid: Valid
Invalid: Invalid

AgreementType

The type of agreement.
KnownAgreementType can be used interchangeably with AgreementType, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
MicrosoftCustomerAgreement: MicrosoftCustomerAgreement
EnterpriseAgreement: EnterpriseAgreement
MicrosoftOnlineServicesProgram: MicrosoftOnlineServicesProgram
MicrosoftPartnerAgreement: MicrosoftPartnerAgreement

AppliedScopeType

Type of the Applied Scope.
KnownAppliedScopeType can be used interchangeably with AppliedScopeType, this enum contains the known values that the service supports.

Known values supported by the service

Single: Single
Shared: Shared
ManagementGroup: ManagementGroup

AutoRenew

Indicates whether auto renewal is turned on or off for a product.
KnownAutoRenew can be used interchangeably with AutoRenew, this enum contains the known values that the service supports.

Known values supported by the service

Off: Off
On: On

AzureSupportedClouds

The supported values for cloud setting as a string literal type

BillingAccountStatusReasonCode

Reason for the specified billing account status.
KnownBillingAccountStatusReasonCode can be used interchangeably with BillingAccountStatusReasonCode, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
UnusualActivity: UnusualActivity
ManuallyTerminated: ManuallyTerminated
Expired: Expired
Transferred: Transferred
TerminateProcessing: TerminateProcessing

BillingManagementTenantState

The state determines whether users from the associated tenant can be assigned roles for commerce activities like viewing and downloading invoices, managing payments, and making purchases.
KnownBillingManagementTenantState can be used interchangeably with BillingManagementTenantState, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
NotAllowed: NotAllowed
Active: Active
Revoked: Revoked

BillingPlan

Represents the billing plan in ISO 8601 format. Required only for monthly purchases.
KnownBillingPlan can be used interchangeably with BillingPlan, this enum contains the known values that the service supports.

Known values supported by the service

P1M: P1M

BillingProfileStatus

The status of the billing profile.
KnownBillingProfileStatus can be used interchangeably with BillingProfileStatus, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
Active: Active
Disabled: Disabled
Warned: Warned
Deleted: Deleted
UnderReview: UnderReview

BillingProfileStatusReasonCode

Reason for the specified billing profile status.
KnownBillingProfileStatusReasonCode can be used interchangeably with BillingProfileStatusReasonCode, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
PastDue: PastDue
UnusualActivity: UnusualActivity
SpendingLimitReached: SpendingLimitReached
SpendingLimitExpired: SpendingLimitExpired

BillingRelationshipType

Identifies the billing relationships represented by a billing account or billing profile. The billing relationship may be between Microsoft, the customer, and/or a third-party.
KnownBillingRelationshipType can be used interchangeably with BillingRelationshipType, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
Direct: Direct
IndirectCustomer: IndirectCustomer
IndirectPartner: IndirectPartner
CSPPartner: CSPPartner
CSPCustomer: CSPCustomer

BillingRequestStatus

Status of billing request.
KnownBillingRequestStatus can be used interchangeably with BillingRequestStatus, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
Pending: Pending
Approved: Approved
Declined: Declined
Cancelled: Cancelled
Completed: Completed
Expired: Expired

BillingRequestType

Type of billing request.
KnownBillingRequestType can be used interchangeably with BillingRequestType, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
InvoiceAccess: InvoiceAccess
ProvisioningAccess: ProvisioningAccess
RoleAssignment: RoleAssignment
UpdateBillingPolicy: UpdateBillingPolicy

BillingSubscriptionOperationStatus

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.
KnownBillingSubscriptionOperationStatus can be used interchangeably with BillingSubscriptionOperationStatus, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
None: None
LockedForUpdate: LockedForUpdate

BillingSubscriptionStatus

The subscription status.
KnownBillingSubscriptionStatus can be used interchangeably with BillingSubscriptionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
Unknown: Unknown
Active: Active
Disabled: Disabled
Deleted: Deleted
Warned: Warned
Expiring: Expiring
Expired: Expired
AutoRenew: AutoRenew
Cancelled: Cancelled
Suspended: Suspended
Failed: Failed

Cancellation

The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed.
KnownCancellation can be used interchangeably with Cancellation, this enum contains the known values that the service supports.

Known values supported by the service

NotAllowed: NotAllowed
Allowed: Allowed

CancellationReason

Cancellation reason.
KnownCancellationReason can be used interchangeably with CancellationReason, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
Compromise: Compromise
Dispute: Dispute

Category

The category of the agreement.
KnownCategory can be used interchangeably with Category, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
AffiliatePurchaseTerms: AffiliatePurchaseTerms
IndirectForGovernmentAgreement: IndirectForGovernmentAgreement
MicrosoftCustomerAgreement: MicrosoftCustomerAgreement
MicrosoftPartnerAgreement: MicrosoftPartnerAgreement
UKCloudComputeFramework: UKCloudComputeFramework

CommitmentGrain

Commitment grain.
KnownCommitmentGrain can be used interchangeably with CommitmentGrain, this enum contains the known values that the service supports.

Known values supported by the service

Hourly: Hourly

ContinuablePage

An interface that describes a page of results.

CreatedByType

The kind of entity that created the resource.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.

CreditType

The credit type of the transaction. Applies only to credited transactions.
KnownCreditType can be used interchangeably with CreditType, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
AzureFreeCredit: AzureFreeCredit
AzureCreditOffer: AzureCreditOffer
ServiceInterruption: ServiceInterruption
Refund: Refund

CustomerStatus

Identifies the status of an customer. This is an upcoming property that will be populated in the future.
KnownCustomerStatus can be used interchangeably with CustomerStatus, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
Active: Active
Pending: Pending
Disabled: Disabled
Warned: Warned
Deleted: Deleted
UnderReview: UnderReview

DeleteBillingProfileEligibilityCode

Code of the delete invoice section eligibility response.
KnownDeleteBillingProfileEligibilityCode can be used interchangeably with DeleteBillingProfileEligibilityCode, this enum contains the known values that the service supports.

Known values supported by the service

None: None
ActiveCredits: ActiveCredits
ActiveCreditCard: ActiveCreditCard
LastBillingProfile: LastBillingProfile
NotSupported: NotSupported
OutstandingCharges: OutstandingCharges
PendingCharges: PendingCharges
ReservedInstances: ReservedInstances
ActiveBillingSubscriptions: ActiveBillingSubscriptions

DeleteBillingProfileEligibilityStatus

Status describing if billing profile is eligible to be deleted.
KnownDeleteBillingProfileEligibilityStatus can be used interchangeably with DeleteBillingProfileEligibilityStatus, this enum contains the known values that the service supports.

Known values supported by the service

Allowed: Allowed
NotAllowed: NotAllowed

DeleteInvoiceSectionEligibilityCode

Code for the delete invoice section validation.
KnownDeleteInvoiceSectionEligibilityCode can be used interchangeably with DeleteInvoiceSectionEligibilityCode, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
LastInvoiceSection: LastInvoiceSection
ActiveAzurePlans: ActiveAzurePlans
ReservedInstances: ReservedInstances
ActiveBillingSubscriptions: ActiveBillingSubscriptions

DeleteInvoiceSectionEligibilityStatus

Status describing if invoice section is eligible to be deleted.
KnownDeleteInvoiceSectionEligibilityStatus can be used interchangeably with DeleteInvoiceSectionEligibilityStatus, this enum contains the known values that the service supports.

Known values supported by the service

Allowed: Allowed
NotAllowed: NotAllowed

DocumentSource

The source of the document. ENF for Brazil and DRS for rest of the world.
KnownDocumentSource can be used interchangeably with DocumentSource, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
DRS: DRS
ENF: ENF

EligibleProductType

Type of the products that can be transferred.
KnownEligibleProductType can be used interchangeably with EligibleProductType, this enum contains the known values that the service supports.

Known values supported by the service

DevTestAzureSubscription: DevTestAzureSubscription
StandardAzureSubscription: StandardAzureSubscription
AzureReservation: AzureReservation

EnrollmentAccountOwnerViewCharges

The policy that controls whether account owner can view charges.
KnownEnrollmentAccountOwnerViewCharges can be used interchangeably with EnrollmentAccountOwnerViewCharges, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
Allowed: Allowed
Disabled: Disabled
NotAllowed: NotAllowed

EnrollmentAuthLevelState

The state showing the enrollment auth level.
KnownEnrollmentAuthLevelState can be used interchangeably with EnrollmentAuthLevelState, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
MicrosoftAccountOnly: MicrosoftAccountOnly
MixedAccount: MixedAccount
OrganizationalAccountCrossTenant: OrganizationalAccountCrossTenant
OrganizationalAccountOnly: OrganizationalAccountOnly

EnrollmentDepartmentAdminViewCharges

The policy that controls whether department admin can view charges.
KnownEnrollmentDepartmentAdminViewCharges can be used interchangeably with EnrollmentDepartmentAdminViewCharges, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
Allowed: Allowed
Disabled: Disabled
NotAllowed: NotAllowed

ExtendedTermOption

The billing account extension opted by the company.
KnownExtendedTermOption can be used interchangeably with ExtendedTermOption, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
Opted-In: Opted-In
Opted-Out: Opted-Out

FailedPaymentReason

The reason that the payment failed.
KnownFailedPaymentReason can be used interchangeably with FailedPaymentReason, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
BankDeclined: BankDeclined
CardExpired: CardExpired
IncorrectCardDetails: IncorrectCardDetails

InitiatorCustomerType

The type of customer of the transfer initiator.
KnownInitiatorCustomerType can be used interchangeably with InitiatorCustomerType, this enum contains the known values that the service supports.

Known values supported by the service

Partner: Partner
EA: EA

InstanceFlexibility

Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type.
KnownInstanceFlexibility can be used interchangeably with InstanceFlexibility, this enum contains the known values that the service supports.

Known values supported by the service

On: On
Off: Off

InvoiceDocumentType

The type of the document.
KnownInvoiceDocumentType can be used interchangeably with InvoiceDocumentType, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
Invoice: Invoice
VoidNote: VoidNote
TaxReceipt: TaxReceipt
CreditNote: CreditNote
Summary: Summary
Transactions: Transactions

InvoiceSectionLabelManagementPolicy

The policy that controls invoice section label management at invoice section scope. This is allowed by default.
KnownInvoiceSectionLabelManagementPolicy can be used interchangeably with InvoiceSectionLabelManagementPolicy, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
Allowed: Allowed
NotAllowed: NotAllowed

InvoiceSectionState

Identifies the status of an invoice section.
KnownInvoiceSectionState can be used interchangeably with InvoiceSectionState, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
Active: Active
Deleted: Deleted
Disabled: Disabled
UnderReview: UnderReview
Warned: Warned
Restricted: Restricted

InvoiceSectionStateReasonCode

Reason for the specified invoice section status.
KnownInvoiceSectionStateReasonCode can be used interchangeably with InvoiceSectionStateReasonCode, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
PastDue: PastDue
UnusualActivity: UnusualActivity
SpendingLimitReached: SpendingLimitReached
SpendingLimitExpired: SpendingLimitExpired

InvoiceStatus

The current status of the invoice.
KnownInvoiceStatus can be used interchangeably with InvoiceStatus, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
Due: Due
OverDue: OverDue
Paid: Paid
Void: Void
Locked: Locked

InvoiceType

Invoice type.
KnownInvoiceType can be used interchangeably with InvoiceType, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
AzureServices: AzureServices
AzureMarketplace: AzureMarketplace
AzureSupport: AzureSupport

MarketplacePurchasesPolicy

The policy that controls whether Azure marketplace purchases are allowed.
KnownMarketplacePurchasesPolicy can be used interchangeably with MarketplacePurchasesPolicy, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
AllAllowed: AllAllowed
Disabled: Disabled
NotAllowed: NotAllowed
OnlyFreeAllowed: OnlyFreeAllowed

MarkupStatus

Markup status of enrollment, applicable only for indirect enrollments.
KnownMarkupStatus can be used interchangeably with MarkupStatus, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
Disabled: Disabled
Preview: Preview
Published: Published
Locked: Locked

MoveValidationErrorCode

Error code for the product transfer validation.
KnownMoveValidationErrorCode can be used interchangeably with MoveValidationErrorCode, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
BillingAccountInactive: BillingAccountInactive
DestinationBillingProfileInactive: DestinationBillingProfileInactive
DestinationBillingProfileNotFound: DestinationBillingProfileNotFound
DestinationBillingProfilePastDue: DestinationBillingProfilePastDue
DestinationInvoiceSectionInactive: DestinationInvoiceSectionInactive
DestinationInvoiceSectionNotFound: DestinationInvoiceSectionNotFound
InsufficientPermissionOnDestination: InsufficientPermissionOnDestination
InsufficientPermissionOnSource: InsufficientPermissionOnSource
InvalidDestination: InvalidDestination
InvalidSource: InvalidSource
MarketplaceNotEnabledOnDestination: MarketplaceNotEnabledOnDestination
ProductInactive: ProductInactive
ProductNotFound: ProductNotFound
ProductTypeNotSupported: ProductTypeNotSupported
SourceBillingProfilePastDue: SourceBillingProfilePastDue
SourceInvoiceSectionInactive: SourceInvoiceSectionInactive

PaymentMethodFamily

Payment on Account type.
KnownPaymentMethodFamily can be used interchangeably with PaymentMethodFamily, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
None: None
CreditCard: CreditCard
Credits: Credits
CheckWire: CheckWire
EWallet: EWallet
TaskOrder: TaskOrder
DirectDebit: DirectDebit

PaymentMethodStatus

Status of the payment method.
KnownPaymentMethodStatus can be used interchangeably with PaymentMethodStatus, this enum contains the known values that the service supports.

Known values supported by the service

active: active
inactive: inactive

PaymentStatus

Describes whether the payment is completed, failed, pending, cancelled or scheduled in the future.
KnownPaymentStatus can be used interchangeably with PaymentStatus, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Succeeded
Failed: Failed
Scheduled: Scheduled
Cancelled: Cancelled
Completed: Completed
Pending: Pending

PaymentTermsEligibilityCode

Indicates the reason for the ineligibility of the payment terms.
KnownPaymentTermsEligibilityCode can be used interchangeably with PaymentTermsEligibilityCode, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
OverlappingPaymentTerms: OverlappingPaymentTerms
InvalidDateFormat: InvalidDateFormat
InvalidDateRange: InvalidDateRange
InactiveBillingAccount: InactiveBillingAccount
InvalidBillingAccountType: InvalidBillingAccountType
NullOrEmptyPaymentTerms: NullOrEmptyPaymentTerms
BillingAccountNotFound: BillingAccountNotFound
IneligibleBillingAccountStatus: IneligibleBillingAccountStatus
InvalidTerms: InvalidTerms

PaymentTermsEligibilityStatus

Indicates the eligibility status of the payment terms.
KnownPaymentTermsEligibilityStatus can be used interchangeably with PaymentTermsEligibilityStatus, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
Valid: Valid
Invalid: Invalid

PolicyType

The type of the policy.
KnownPolicyType can be used interchangeably with PolicyType, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
UserControlled: UserControlled
SystemControlled: SystemControlled

PrincipalType

The type of a role Assignment.
KnownPrincipalType can be used interchangeably with PrincipalType, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: Unknown
None: None
User: User
Group: Group
DirectoryRole: DirectoryRole
ServicePrincipal: ServicePrincipal
Everyone: Everyone

ProductStatus

The status of the product.
KnownProductStatus can be used interchangeably with ProductStatus, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
Active: Active
Disabled: Disabled
Deleted: Deleted
PastDue: PastDue
Expiring: Expiring
Expired: Expired
AutoRenew: AutoRenew
Canceled: Canceled
Suspended: Suspended

ProductTransferStatus

The status of a transfer.
KnownProductTransferStatus can be used interchangeably with ProductTransferStatus, this enum contains the known values that the service supports.

Known values supported by the service

NotStarted: NotStarted
InProgress: InProgress
Completed: Completed
Failed: Failed

ProductType

The type of product that is transferred.
KnownProductType can be used interchangeably with ProductType, this enum contains the known values that the service supports.

Known values supported by the service

AzureSubscription: AzureSubscription
AzureReservation: AzureReservation
Department: Department
SavingsPlan: SavingsPlan
SAAS: SAAS

ProvisioningState

The provisioning state of the resource during a long-running operation.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Succeeded
Canceled: Canceled
Failed: Failed
New: New
Pending: Pending
Provisioning: Provisioning
PendingBilling: PendingBilling
ConfirmedBilling: ConfirmedBilling
Creating: Creating
Created: Created
Expired: Expired

ProvisioningTenantState

The state determines whether subscriptions and licenses can be provisioned in the associated tenant. It can be set to 'Pending' to initiate a billing request.
KnownProvisioningTenantState can be used interchangeably with ProvisioningTenantState, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
NotRequested: NotRequested
Active: Active
Pending: Pending
BillingRequestExpired: BillingRequestExpired
BillingRequestDeclined: BillingRequestDeclined
Revoked: Revoked

RefundReasonCode

The reason for refund.
KnownRefundReasonCode can be used interchangeably with RefundReasonCode, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
AccidentalConversion: AccidentalConversion
UnclearPricing: UnclearPricing
AccidentalPurchase: AccidentalPurchase
ForgotToCancel: ForgotToCancel
UnclearDocumentation: UnclearDocumentation

RefundStatus

The status of refund request.
KnownRefundStatus can be used interchangeably with RefundStatus, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
Pending: Pending
Approved: Approved
Declined: Declined
Cancelled: Cancelled
Completed: Completed
Expired: Expired

ReservationBillingPlan

Represent the billing plans.
KnownReservationBillingPlan can be used interchangeably with ReservationBillingPlan, this enum contains the known values that the service supports.

Known values supported by the service

Upfront: Upfront
Monthly: Monthly

ReservationPurchasesPolicy

The policy that controls whether Azure reservation purchases are allowed.
KnownReservationPurchasesPolicy can be used interchangeably with ReservationPurchasesPolicy, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
Allowed: Allowed
Disabled: Disabled
NotAllowed: NotAllowed

ReservationStatusCode

The status of the reservation.
KnownReservationStatusCode can be used interchangeably with ReservationStatusCode, this enum contains the known values that the service supports.

Known values supported by the service

None: None
Pending: Pending
Processing: Processing
Active: Active
PurchaseError: PurchaseError
PaymentInstrumentError: PaymentInstrumentError
Split: Split
Merged: Merged
Expired: Expired
Succeeded: Succeeded
CapacityError: CapacityError
CapacityRestricted: CapacityRestricted
Exchanged: Exchanged
UnknownError: UnknownError
RiskCheckFailed: RiskCheckFailed
CreditLineCheckFailed: CreditLineCheckFailed
Warning: Warning
NoBenefitDueToSubscriptionTransfer: NoBenefitDueToSubscriptionTransfer
NoBenefitDueToSubscriptionDeletion: NoBenefitDueToSubscriptionDeletion
NoBenefit: NoBenefit

SavingsPlanPurchasesPolicy

The policy that controls whether users with Azure savings plan purchase are allowed.
KnownSavingsPlanPurchasesPolicy can be used interchangeably with SavingsPlanPurchasesPolicy, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
Allowed: Allowed
Disabled: Disabled
NotAllowed: NotAllowed

SavingsPlanTerm

Represents the Savings plan term in ISO 8601 format.
KnownSavingsPlanTerm can be used interchangeably with SavingsPlanTerm, this enum contains the known values that the service supports.

Known values supported by the service

P1Y: P1Y
P3Y: P3Y
P5Y: P5Y

ServiceDefinedResourceName

Type of ServiceDefinedResourceName

SpecialTaxationType

Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic.
KnownSpecialTaxationType can be used interchangeably with SpecialTaxationType, this enum contains the known values that the service supports.

Known values supported by the service

SubtotalLevel: SubtotalLevel
InvoiceLevel: InvoiceLevel

SpendingLimit

The billing profile spending limit.
KnownSpendingLimit can be used interchangeably with SpendingLimit, this enum contains the known values that the service supports.

Known values supported by the service

Off: Off
On: On

SpendingLimitStatus

The status of current spending limit.
KnownSpendingLimitStatus can be used interchangeably with SpendingLimitStatus, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
None: None
Active: Active
Expired: Expired
LimitReached: LimitReached
LimitRemoved: LimitRemoved

SpendingLimitType

The type of spending limit.
KnownSpendingLimitType can be used interchangeably with SpendingLimitType, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
None: None
FreeAccount: FreeAccount
Sandbox: Sandbox
AzureForStudents: AzureForStudents
AcademicSponsorship: AcademicSponsorship
AzureConsumptionCredit: AzureConsumptionCredit
AzurePassSponsorship: AzurePassSponsorship
MpnSponsorship: MpnSponsorship
MSDN: MSDN
NonProfitSponsorship: NonProfitSponsorship
Sponsorship: Sponsorship
StartupSponsorship: StartupSponsorship
AzureForStudentsStarter: AzureForStudentsStarter
VisualStudio: VisualStudio

SubscriptionBillingType

The type of billing subscription.
KnownSubscriptionBillingType can be used interchangeably with SubscriptionBillingType, this enum contains the known values that the service supports.

Known values supported by the service

None: None
Benefit: Benefit
Free: Free
Paid: Paid
PrePaid: PrePaid

SubscriptionEnrollmentAccountStatus

The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type.
KnownSubscriptionEnrollmentAccountStatus can be used interchangeably with SubscriptionEnrollmentAccountStatus, this enum contains the known values that the service supports.

Known values supported by the service

Active: Active
Cancelled: Cancelled
Expired: Expired
Deleted: Deleted
TransferredOut: TransferredOut
Transferring: Transferring
Inactive: Inactive

SubscriptionStatusReason

The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts.
KnownSubscriptionStatusReason can be used interchangeably with SubscriptionStatusReason, this enum contains the known values that the service supports.

Known values supported by the service

None: None
Cancelled: Cancelled
PastDue: PastDue
SuspiciousActivity: SuspiciousActivity
Other: Other
Transferred: Transferred
PolicyViolation: PolicyViolation
SpendingLimitReached: SpendingLimitReached
Expired: Expired

SubscriptionTransferValidationErrorCode

Error code of the transfer validation response.
KnownSubscriptionTransferValidationErrorCode can be used interchangeably with SubscriptionTransferValidationErrorCode, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
BillingAccountInactive: BillingAccountInactive
DestinationBillingProfileInactive: DestinationBillingProfileInactive
DestinationBillingProfileNotFound: DestinationBillingProfileNotFound
DestinationBillingProfilePastDue: DestinationBillingProfilePastDue
DestinationInvoiceSectionInactive: DestinationInvoiceSectionInactive
DestinationInvoiceSectionNotFound: DestinationInvoiceSectionNotFound
InsufficientPermissionOnDestination: InsufficientPermissionOnDestination
InsufficientPermissionOnSource: InsufficientPermissionOnSource
InvalidDestination: InvalidDestination
InvalidSource: InvalidSource
MarketplaceNotEnabledOnDestination: MarketplaceNotEnabledOnDestination
ProductInactive: ProductInactive
ProductNotFound: ProductNotFound
ProductTypeNotSupported: ProductTypeNotSupported
SourceBillingProfilePastDue: SourceBillingProfilePastDue
SourceInvoiceSectionInactive: SourceInvoiceSectionInactive
AccountIsLocked: AccountIsLocked
AssetHasCap: AssetHasCap
AssetNotActive: AssetNotActive
BillingProfilePastDue: BillingProfilePastDue
CrossBillingAccountNotAllowed: CrossBillingAccountNotAllowed
NoActiveAzurePlan: NoActiveAzurePlan
None: None
SubscriptionNotActive: SubscriptionNotActive
SubscriptionHasReservations: SubscriptionHasReservations
SubscriptionTypeNotSupported: SubscriptionTypeNotSupported
InvoiceSectionIsRestricted: InvoiceSectionIsRestricted

SubscriptionWorkloadType

The Azure workload type of the subscription.
KnownSubscriptionWorkloadType can be used interchangeably with SubscriptionWorkloadType, this enum contains the known values that the service supports.

Known values supported by the service

None: None
Production: Production
DevTest: DevTest
Internal: Internal

SupportLevel

The support level offer associated with an enrollment.
KnownSupportLevel can be used interchangeably with SupportLevel, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
Standard: Standard
Pro-Direct: Pro-Direct
Developer: Developer

SupportedAccountType

The supported account types.
KnownSupportedAccountType can be used interchangeably with SupportedAccountType, this enum contains the known values that the service supports.

Known values supported by the service

None: None
Partner: Partner
Individual: Individual
Enterprise: Enterprise

TaxIdentifierStatus

The status of the tax identifier.
KnownTaxIdentifierStatus can be used interchangeably with TaxIdentifierStatus, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
Valid: Valid
Invalid: Invalid

TaxIdentifierType

The type of the tax identifier.
KnownTaxIdentifierType can be used interchangeably with TaxIdentifierType, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
BrazilCcmId: BrazilCcmId
BrazilCnpjId: BrazilCnpjId
BrazilCpfId: BrazilCpfId
CanadianFederalExempt: CanadianFederalExempt
CanadianProvinceExempt: CanadianProvinceExempt
ExternalTaxation: ExternalTaxation
IndiaFederalTanId: IndiaFederalTanId
IndiaFederalServiceTaxId: IndiaFederalServiceTaxId
IndiaPanId: IndiaPanId
IndiaStateCstId: IndiaStateCstId
IndiaStateGstINId: IndiaStateGstINId
IndiaStateVatId: IndiaStateVatId
IntlExempt: IntlExempt
USExempt: USExempt
VatId: VatId
LoveCode: LoveCode
MobileBarCode: MobileBarCode
NationalIdentificationNumber: NationalIdentificationNumber
PublicSectorId: PublicSectorId

TransactionKind

Type of the transaction, billed or unbilled.
KnownTransactionKind can be used interchangeably with TransactionKind, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
All: All
Reservation: Reservation

TransactionType

Type of TransactionType

TransferStatus

The status of a transfer.
KnownTransferStatus can be used interchangeably with TransferStatus, this enum contains the known values that the service supports.

Known values supported by the service

Expired: Expired
Pending: Pending
InProgress: InProgress
Completed: Completed
CompletedWithErrors: CompletedWithErrors
Failed: Failed
Canceled: Canceled
Declined: Declined

ViewChargesPolicy

The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices.
KnownViewChargesPolicy can be used interchangeably with ViewChargesPolicy, this enum contains the known values that the service supports.

Known values supported by the service

Other: Other
Allowed: Allowed
NotAllowed: NotAllowed

Enums

AzureClouds

An enum to describe Azure Cloud environments.

KnownAcceptanceMode

The mode of acceptance for an agreement.

KnownAccessDecision

Access Decision, specifies access is allowed or not.

KnownAccountStatus

The current status of the billing account.

KnownAccountSubType

The tier of the account.

KnownAccountType

The type of customer.

KnownAddressValidationStatus

Status of the address validation.

KnownAgreementType

The type of agreement.

KnownAppliedScopeType

Type of the Applied Scope.

KnownAutoRenew

Indicates whether auto renewal is turned on or off for a product.

KnownBillingAccountStatusReasonCode

Reason for the specified billing account status.

KnownBillingManagementTenantState

The state determines whether users from the associated tenant can be assigned roles for commerce activities like viewing and downloading invoices, managing payments, and making purchases.

KnownBillingPlan

Represents the billing plan in ISO 8601 format. Required only for monthly purchases.

KnownBillingProfileStatus

The status of the billing profile.

KnownBillingProfileStatusReasonCode

Reason for the specified billing profile status.

KnownBillingRelationshipType

Identifies the billing relationships represented by a billing account or billing profile. The billing relationship may be between Microsoft, the customer, and/or a third-party.

KnownBillingRequestStatus

Status of billing request.

KnownBillingRequestType

Type of billing request.

KnownBillingSubscriptionOperationStatus

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.

KnownBillingSubscriptionStatus

The subscription status.

KnownCancellation

The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed.

KnownCancellationReason

Cancellation reason.

KnownCategory

The category of the agreement.

KnownCommitmentGrain

Commitment grain.

KnownCreatedByType

The kind of entity that created the resource.

KnownCreditType

The credit type of the transaction. Applies only to credited transactions.

KnownCustomerStatus

Identifies the status of an customer. This is an upcoming property that will be populated in the future.

KnownDeleteBillingProfileEligibilityCode

Code of the delete invoice section eligibility response.

KnownDeleteBillingProfileEligibilityStatus

Status describing if billing profile is eligible to be deleted.

KnownDeleteInvoiceSectionEligibilityCode

Code for the delete invoice section validation.

KnownDeleteInvoiceSectionEligibilityStatus

Status describing if invoice section is eligible to be deleted.

KnownDocumentSource

The source of the document. ENF for Brazil and DRS for rest of the world.

KnownEligibleProductType

Type of the products that can be transferred.

KnownEnrollmentAccountOwnerViewCharges

The policy that controls whether account owner can view charges.

KnownEnrollmentAuthLevelState

The state showing the enrollment auth level.

KnownEnrollmentDepartmentAdminViewCharges

The policy that controls whether department admin can view charges.

KnownExtendedTermOption

The billing account extension opted by the company.

KnownFailedPaymentReason

The reason that the payment failed.

KnownInitiatorCustomerType

The type of customer of the transfer initiator.

KnownInstanceFlexibility

Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type.

KnownInvoiceDocumentType

The type of the document.

KnownInvoiceSectionLabelManagementPolicy

The policy that controls invoice section label management at invoice section scope. This is allowed by default.

KnownInvoiceSectionState

Identifies the status of an invoice section.

KnownInvoiceSectionStateReasonCode

Reason for the specified invoice section status.

KnownInvoiceStatus

The current status of the invoice.

KnownInvoiceType

Invoice type.

KnownMarketplacePurchasesPolicy

The policy that controls whether Azure marketplace purchases are allowed.

KnownMarkupStatus

Markup status of enrollment, applicable only for indirect enrollments.

KnownMoveValidationErrorCode

Error code for the product transfer validation.

KnownPaymentMethodFamily

Payment on Account type.

KnownPaymentMethodStatus

Status of the payment method.

KnownPaymentStatus

Describes whether the payment is completed, failed, pending, cancelled or scheduled in the future.

KnownPaymentTermsEligibilityCode

Indicates the reason for the ineligibility of the payment terms.

KnownPaymentTermsEligibilityStatus

Indicates the eligibility status of the payment terms.

KnownPolicyType

The type of the policy.

KnownPrincipalType

The type of a role Assignment.

KnownProductStatus

The status of the product.

KnownProductTransferStatus

The status of a transfer.

KnownProductType

The type of product that is transferred.

KnownProvisioningState

The provisioning state of the resource during a long-running operation.

KnownProvisioningTenantState

The state determines whether subscriptions and licenses can be provisioned in the associated tenant. It can be set to 'Pending' to initiate a billing request.

KnownRefundReasonCode

The reason for refund.

KnownRefundStatus

The status of refund request.

KnownReservationBillingPlan

Represent the billing plans.

KnownReservationPurchasesPolicy

The policy that controls whether Azure reservation purchases are allowed.

KnownReservationStatusCode

The status of the reservation.

KnownSavingsPlanPurchasesPolicy

The policy that controls whether users with Azure savings plan purchase are allowed.

KnownSavingsPlanTerm

Represents the Savings plan term in ISO 8601 format.

KnownServiceDefinedResourceName

Known values of ServiceDefinedResourceName that the service accepts.

KnownSpecialTaxationType

Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic.

KnownSpendingLimit

The billing profile spending limit.

KnownSpendingLimitStatus

The status of current spending limit.

KnownSpendingLimitType

The type of spending limit.

KnownSubscriptionBillingType

The type of billing subscription.

KnownSubscriptionEnrollmentAccountStatus

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

KnownSubscriptionStatusReason

The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts.

KnownSubscriptionTransferValidationErrorCode

Error code of the transfer validation response.

KnownSubscriptionWorkloadType

The Azure workload type of the subscription.

KnownSupportLevel

The support level offer associated with an enrollment.

KnownSupportedAccountType

The supported account types.

KnownTaxIdentifierStatus

The status of the tax identifier.

KnownTaxIdentifierType

The type of the tax identifier.

KnownTransactionKind

Type of the transaction, billed or unbilled.

KnownTransactionType

Known values of TransactionType that the service accepts.

KnownTransferStatus

The status of a transfer.

KnownVersions

The available API versions.

KnownViewChargesPolicy

The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices.

Functions

isRestError(unknown)

Typeguard for RestError

restorePoller<TResponse, TResult>(BillingManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(BillingManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: BillingManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type