BillingAccounts interface

Interface representing a BillingAccounts.

Methods

beginAddPaymentTerms(string, PaymentTerm[], BillingAccountsAddPaymentTermsOptionalParams)

Adds payment terms to all the billing profiles under the billing account. Currently, payment terms can be added only on billing accounts that have Agreement Type as 'Microsoft Customer Agreement' and AccountType as 'Enterprise'. This action needs pre-authorization and only Field Sellers are authorized to add the payment terms and is not a self-serve action.

beginAddPaymentTermsAndWait(string, PaymentTerm[], BillingAccountsAddPaymentTermsOptionalParams)

Adds payment terms to all the billing profiles under the billing account. Currently, payment terms can be added only on billing accounts that have Agreement Type as 'Microsoft Customer Agreement' and AccountType as 'Enterprise'. This action needs pre-authorization and only Field Sellers are authorized to add the payment terms and is not a self-serve action.

beginCancelPaymentTerms(string, Date, BillingAccountsCancelPaymentTermsOptionalParams)

Cancels all the payment terms on billing account that falls after the cancellation date in the request. Currently, cancel payment terms is only served by admin actions and is not a self-serve action.

beginCancelPaymentTermsAndWait(string, Date, BillingAccountsCancelPaymentTermsOptionalParams)

Cancels all the payment terms on billing account that falls after the cancellation date in the request. Currently, cancel payment terms is only served by admin actions and is not a self-serve action.

beginUpdate(string, BillingAccountPatch, BillingAccountsUpdateOptionalParams)

Updates the properties of a billing account. Currently, displayName and address can be updated for billing accounts with agreement type Microsoft Customer Agreement. Currently address and notification email address can be updated for billing accounts with agreement type Microsoft Online Services Agreement. Currently, purchase order number can be edited for billing accounts with agreement type Enterprise Agreement.

beginUpdateAndWait(string, BillingAccountPatch, BillingAccountsUpdateOptionalParams)

Updates the properties of a billing account. Currently, displayName and address can be updated for billing accounts with agreement type Microsoft Customer Agreement. Currently address and notification email address can be updated for billing accounts with agreement type Microsoft Online Services Agreement. Currently, purchase order number can be edited for billing accounts with agreement type Enterprise Agreement.

confirmTransition(string, BillingAccountsConfirmTransitionOptionalParams)

Gets the transition details for a billing account that has transitioned from agreement type Microsoft Online Services Program to agreement type Microsoft Customer Agreement.

get(string, BillingAccountsGetOptionalParams)

Gets a billing account by its ID.

list(BillingAccountsListOptionalParams)

Lists the billing accounts that a user has access to.

listInvoiceSectionsByCreateSubscriptionPermission(string, BillingAccountsListInvoiceSectionsByCreateSubscriptionPermissionOptionalParams)

Lists the invoice sections for which the user has permission to create Azure subscriptions. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

validatePaymentTerms(string, PaymentTerm[], BillingAccountsValidatePaymentTermsOptionalParams)

Validates payment terms on a billing account with agreement type 'Microsoft Customer Agreement' and account type 'Enterprise'.

Method Details

beginAddPaymentTerms(string, PaymentTerm[], BillingAccountsAddPaymentTermsOptionalParams)

Adds payment terms to all the billing profiles under the billing account. Currently, payment terms can be added only on billing accounts that have Agreement Type as 'Microsoft Customer Agreement' and AccountType as 'Enterprise'. This action needs pre-authorization and only Field Sellers are authorized to add the payment terms and is not a self-serve action.

function beginAddPaymentTerms(billingAccountName: string, parameters: PaymentTerm[], options?: BillingAccountsAddPaymentTermsOptionalParams): Promise<SimplePollerLike<OperationState<BillingAccount>, BillingAccount>>

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

parameters

PaymentTerm[]

The properties of payment term.

options
BillingAccountsAddPaymentTermsOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<BillingAccount>, BillingAccount>>

beginAddPaymentTermsAndWait(string, PaymentTerm[], BillingAccountsAddPaymentTermsOptionalParams)

Adds payment terms to all the billing profiles under the billing account. Currently, payment terms can be added only on billing accounts that have Agreement Type as 'Microsoft Customer Agreement' and AccountType as 'Enterprise'. This action needs pre-authorization and only Field Sellers are authorized to add the payment terms and is not a self-serve action.

function beginAddPaymentTermsAndWait(billingAccountName: string, parameters: PaymentTerm[], options?: BillingAccountsAddPaymentTermsOptionalParams): Promise<BillingAccount>

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

parameters

PaymentTerm[]

The properties of payment term.

options
BillingAccountsAddPaymentTermsOptionalParams

The options parameters.

Returns

Promise<BillingAccount>

beginCancelPaymentTerms(string, Date, BillingAccountsCancelPaymentTermsOptionalParams)

Cancels all the payment terms on billing account that falls after the cancellation date in the request. Currently, cancel payment terms is only served by admin actions and is not a self-serve action.

function beginCancelPaymentTerms(billingAccountName: string, parameters: Date, options?: BillingAccountsCancelPaymentTermsOptionalParams): Promise<SimplePollerLike<OperationState<BillingAccount>, BillingAccount>>

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

parameters

Date

Date after which any payment terms that needs to be cancelled.

options
BillingAccountsCancelPaymentTermsOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<BillingAccount>, BillingAccount>>

beginCancelPaymentTermsAndWait(string, Date, BillingAccountsCancelPaymentTermsOptionalParams)

Cancels all the payment terms on billing account that falls after the cancellation date in the request. Currently, cancel payment terms is only served by admin actions and is not a self-serve action.

function beginCancelPaymentTermsAndWait(billingAccountName: string, parameters: Date, options?: BillingAccountsCancelPaymentTermsOptionalParams): Promise<BillingAccount>

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

parameters

Date

Date after which any payment terms that needs to be cancelled.

options
BillingAccountsCancelPaymentTermsOptionalParams

The options parameters.

Returns

Promise<BillingAccount>

beginUpdate(string, BillingAccountPatch, BillingAccountsUpdateOptionalParams)

Updates the properties of a billing account. Currently, displayName and address can be updated for billing accounts with agreement type Microsoft Customer Agreement. Currently address and notification email address can be updated for billing accounts with agreement type Microsoft Online Services Agreement. Currently, purchase order number can be edited for billing accounts with agreement type Enterprise Agreement.

function beginUpdate(billingAccountName: string, parameters: BillingAccountPatch, options?: BillingAccountsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<BillingAccount>, BillingAccount>>

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

parameters
BillingAccountPatch

A billing account.

options
BillingAccountsUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<BillingAccount>, BillingAccount>>

beginUpdateAndWait(string, BillingAccountPatch, BillingAccountsUpdateOptionalParams)

Updates the properties of a billing account. Currently, displayName and address can be updated for billing accounts with agreement type Microsoft Customer Agreement. Currently address and notification email address can be updated for billing accounts with agreement type Microsoft Online Services Agreement. Currently, purchase order number can be edited for billing accounts with agreement type Enterprise Agreement.

function beginUpdateAndWait(billingAccountName: string, parameters: BillingAccountPatch, options?: BillingAccountsUpdateOptionalParams): Promise<BillingAccount>

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

parameters
BillingAccountPatch

A billing account.

options
BillingAccountsUpdateOptionalParams

The options parameters.

Returns

Promise<BillingAccount>

confirmTransition(string, BillingAccountsConfirmTransitionOptionalParams)

Gets the transition details for a billing account that has transitioned from agreement type Microsoft Online Services Program to agreement type Microsoft Customer Agreement.

function confirmTransition(billingAccountName: string, options?: BillingAccountsConfirmTransitionOptionalParams): Promise<TransitionDetails>

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

options
BillingAccountsConfirmTransitionOptionalParams

The options parameters.

Returns

get(string, BillingAccountsGetOptionalParams)

Gets a billing account by its ID.

function get(billingAccountName: string, options?: BillingAccountsGetOptionalParams): Promise<BillingAccount>

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

options
BillingAccountsGetOptionalParams

The options parameters.

Returns

Promise<BillingAccount>

list(BillingAccountsListOptionalParams)

Lists the billing accounts that a user has access to.

function list(options?: BillingAccountsListOptionalParams): PagedAsyncIterableIterator<BillingAccount, BillingAccount[], PageSettings>

Parameters

options
BillingAccountsListOptionalParams

The options parameters.

Returns

listInvoiceSectionsByCreateSubscriptionPermission(string, BillingAccountsListInvoiceSectionsByCreateSubscriptionPermissionOptionalParams)

Lists the invoice sections for which the user has permission to create Azure subscriptions. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

function listInvoiceSectionsByCreateSubscriptionPermission(billingAccountName: string, options?: BillingAccountsListInvoiceSectionsByCreateSubscriptionPermissionOptionalParams): PagedAsyncIterableIterator<InvoiceSectionWithCreateSubPermission, InvoiceSectionWithCreateSubPermission[], PageSettings>

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

Returns

validatePaymentTerms(string, PaymentTerm[], BillingAccountsValidatePaymentTermsOptionalParams)

Validates payment terms on a billing account with agreement type 'Microsoft Customer Agreement' and account type 'Enterprise'.

function validatePaymentTerms(billingAccountName: string, parameters: PaymentTerm[], options?: BillingAccountsValidatePaymentTermsOptionalParams): Promise<PaymentTermsEligibilityResult>

Parameters

billingAccountName

string

The ID that uniquely identifies a billing account.

parameters

PaymentTerm[]

The properties of payment term.

options
BillingAccountsValidatePaymentTermsOptionalParams

The options parameters.

Returns