PaymentMethods interface
Interface representing a PaymentMethods.
Methods
| delete |
Deletes a payment method owned by the caller. |
| get |
Gets a payment method available for a billing account. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement. |
| get |
Gets a payment method linked with a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement. |
| get |
Gets a payment method owned by the caller. |
| list |
Lists the payment methods available for a billing account. Along with the payment methods owned by the caller, these payment methods can be attached to a billing profile to make payments. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement. |
| list |
Lists payment methods attached to a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement. |
| list |
Lists the payment methods owned by the caller. |
Method Details
deleteByUser(string, PaymentMethodsDeleteByUserOptionalParams)
Deletes a payment method owned by the caller.
function deleteByUser(paymentMethodName: string, options?: PaymentMethodsDeleteByUserOptionalParams): Promise<void>Parameters
- paymentMethodName
-
string
The ID that uniquely identifies a payment method.
The options parameters.
Returns
Promise<void>
getByBillingAccount(string, string, PaymentMethodsGetByBillingAccountOptionalParams)
Gets a payment method available for a billing account. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
function getByBillingAccount(billingAccountName: string, paymentMethodName: string, options?: PaymentMethodsGetByBillingAccountOptionalParams): Promise<PaymentMethod>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- paymentMethodName
-
string
The ID that uniquely identifies a payment method.
The options parameters.
Returns
Promise<PaymentMethod>
getByBillingProfile(string, string, string, PaymentMethodsGetByBillingProfileOptionalParams)
Gets a payment method linked with a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
function getByBillingProfile(billingAccountName: string, billingProfileName: string, paymentMethodName: string, options?: PaymentMethodsGetByBillingProfileOptionalParams): Promise<PaymentMethodLink>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- billingProfileName
-
string
The ID that uniquely identifies a billing profile.
- paymentMethodName
-
string
The ID that uniquely identifies a payment method.
The options parameters.
Returns
Promise<PaymentMethodLink>
getByUser(string, PaymentMethodsGetByUserOptionalParams)
Gets a payment method owned by the caller.
function getByUser(paymentMethodName: string, options?: PaymentMethodsGetByUserOptionalParams): Promise<PaymentMethod>Parameters
- paymentMethodName
-
string
The ID that uniquely identifies a payment method.
The options parameters.
Returns
Promise<PaymentMethod>
listByBillingAccount(string, PaymentMethodsListByBillingAccountOptionalParams)
Lists the payment methods available for a billing account. Along with the payment methods owned by the caller, these payment methods can be attached to a billing profile to make payments. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
function listByBillingAccount(billingAccountName: string, options?: PaymentMethodsListByBillingAccountOptionalParams): PagedAsyncIterableIterator<PaymentMethod, PaymentMethod[], PageSettings>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
The options parameters.
Returns
listByBillingProfile(string, string, PaymentMethodsListByBillingProfileOptionalParams)
Lists payment methods attached to a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
function listByBillingProfile(billingAccountName: string, billingProfileName: string, options?: PaymentMethodsListByBillingProfileOptionalParams): PagedAsyncIterableIterator<PaymentMethodLink, PaymentMethodLink[], PageSettings>Parameters
- billingAccountName
-
string
The ID that uniquely identifies a billing account.
- billingProfileName
-
string
The ID that uniquely identifies a billing profile.
The options parameters.
Returns
listByUser(PaymentMethodsListByUserOptionalParams)
Lists the payment methods owned by the caller.
function listByUser(options?: PaymentMethodsListByUserOptionalParams): PagedAsyncIterableIterator<PaymentMethod, PaymentMethod[], PageSettings>Parameters
The options parameters.