PaymentMethodsClient Interface

public interface PaymentMethodsClient

An instance of this class provides access to all the operations defined in PaymentMethodsClient.

Method Summary

Modifier and Type Method and Description
abstract void deleteByUser(String paymentMethodName)

Deletes a payment method owned by the caller.

abstract Response<Void> deleteByUserWithResponse(String paymentMethodName, Context context)

Deletes a payment method owned by the caller.

abstract PaymentMethodInner getByBillingAccount(String billingAccountName, String paymentMethodName)

Gets a payment method available for a billing account.

abstract Response<PaymentMethodInner> getByBillingAccountWithResponse(String billingAccountName, String paymentMethodName, Context context)

Gets a payment method available for a billing account.

abstract PaymentMethodLinkInner getByBillingProfile(String billingAccountName, String billingProfileName, String paymentMethodName)

Gets a payment method linked with a billing profile.

abstract Response<PaymentMethodLinkInner> getByBillingProfileWithResponse(String billingAccountName, String billingProfileName, String paymentMethodName, Context context)

Gets a payment method linked with a billing profile.

abstract PaymentMethodInner getByUser(String paymentMethodName)

Gets a payment method owned by the caller.

abstract Response<PaymentMethodInner> getByUserWithResponse(String paymentMethodName, Context context)

Gets a payment method owned by the caller.

abstract PagedIterable<PaymentMethodInner> listByBillingAccount(String billingAccountName)

Lists the payment methods available for a billing account.

abstract PagedIterable<PaymentMethodInner> listByBillingAccount(String billingAccountName, Context context)

Lists the payment methods available for a billing account.

abstract PagedIterable<PaymentMethodLinkInner> listByBillingProfile(String billingAccountName, String billingProfileName)

Lists payment methods attached to a billing profile.

abstract PagedIterable<PaymentMethodLinkInner> listByBillingProfile(String billingAccountName, String billingProfileName, Context context)

Lists payment methods attached to a billing profile.

abstract PagedIterable<PaymentMethodInner> listByUser()

Lists the payment methods owned by the caller.

abstract PagedIterable<PaymentMethodInner> listByUser(Context context)

Lists the payment methods owned by the caller.

Method Details

deleteByUser

public abstract void deleteByUser(String paymentMethodName)

Deletes a payment method owned by the caller.

Parameters:

paymentMethodName - The ID that uniquely identifies a payment method.

deleteByUserWithResponse

public abstract Response<Void> deleteByUserWithResponse(String paymentMethodName, Context context)

Deletes a payment method owned by the caller.

Parameters:

paymentMethodName - The ID that uniquely identifies a payment method.
context - The context to associate with this operation.

Returns:

getByBillingAccount

public abstract PaymentMethodInner getByBillingAccount(String billingAccountName, String paymentMethodName)

Gets a payment method available for a billing account. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.
paymentMethodName - The ID that uniquely identifies a payment method.

Returns:

a payment method available for a billing account.

getByBillingAccountWithResponse

public abstract Response<PaymentMethodInner> getByBillingAccountWithResponse(String billingAccountName, String paymentMethodName, Context context)

Gets a payment method available for a billing account. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.
paymentMethodName - The ID that uniquely identifies a payment method.
context - The context to associate with this operation.

Returns:

a payment method available for a billing account along with Response<T>.

getByBillingProfile

public abstract PaymentMethodLinkInner getByBillingProfile(String billingAccountName, String billingProfileName, String paymentMethodName)

Gets a payment method linked with a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.
billingProfileName - The ID that uniquely identifies a billing profile.
paymentMethodName - The ID that uniquely identifies a payment method.

Returns:

a payment method linked with a billing profile.

getByBillingProfileWithResponse

public abstract Response<PaymentMethodLinkInner> getByBillingProfileWithResponse(String billingAccountName, String billingProfileName, String paymentMethodName, Context context)

Gets a payment method linked with a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.
billingProfileName - The ID that uniquely identifies a billing profile.
paymentMethodName - The ID that uniquely identifies a payment method.
context - The context to associate with this operation.

Returns:

a payment method linked with a billing profile along with Response<T>.

getByUser

public abstract PaymentMethodInner getByUser(String paymentMethodName)

Gets a payment method owned by the caller.

Parameters:

paymentMethodName - The ID that uniquely identifies a payment method.

Returns:

a payment method owned by the caller.

getByUserWithResponse

public abstract Response<PaymentMethodInner> getByUserWithResponse(String paymentMethodName, Context context)

Gets a payment method owned by the caller.

Parameters:

paymentMethodName - The ID that uniquely identifies a payment method.
context - The context to associate with this operation.

Returns:

a payment method owned by the caller along with Response<T>.

listByBillingAccount

public abstract PagedIterable<PaymentMethodInner> listByBillingAccount(String billingAccountName)

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.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.

Returns:

the list of payment methods as paginated response with PagedIterable<T>.

listByBillingAccount

public abstract PagedIterable<PaymentMethodInner> listByBillingAccount(String billingAccountName, Context context)

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.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.
context - The context to associate with this operation.

Returns:

the list of payment methods as paginated response with PagedIterable<T>.

listByBillingProfile

public abstract PagedIterable<PaymentMethodLinkInner> listByBillingProfile(String billingAccountName, String billingProfileName)

Lists payment methods attached to a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.
billingProfileName - The ID that uniquely identifies a billing profile.

Returns:

the list of payment method links as paginated response with PagedIterable<T>.

listByBillingProfile

public abstract PagedIterable<PaymentMethodLinkInner> listByBillingProfile(String billingAccountName, String billingProfileName, Context context)

Lists payment methods attached to a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

Parameters:

billingAccountName - The ID that uniquely identifies a billing account.
billingProfileName - The ID that uniquely identifies a billing profile.
context - The context to associate with this operation.

Returns:

the list of payment method links as paginated response with PagedIterable<T>.

listByUser

public abstract PagedIterable<PaymentMethodInner> listByUser()

Lists the payment methods owned by the caller.

Returns:

the list of payment methods as paginated response with PagedIterable<T>.

listByUser

public abstract PagedIterable<PaymentMethodInner> listByUser(Context context)

Lists the payment methods owned by the caller.

Parameters:

context - The context to associate with this operation.

Returns:

the list of payment methods as paginated response with PagedIterable<T>.

Applies to