payment_methods

Creates, updates, deletes, gets or lists a payment_methods resource.

Overview

Name	payment_methods
Type	Resource
Id	azure.billing.payment_methods

Fields

The following fields are returned by SELECT queries:

get_by_billing_profile

OK. The request has succeeded.

Name	Datatype	Description
properties	object	Payment method link properties
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /

list_by_billing_profile

OK. The request has succeeded.

Name	Datatype	Description
properties	object	Payment method link properties
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /

get_by_billing_account

OK. The request has succeeded.

Name	Datatype	Description
properties	object	Payment method properties
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /

list_by_billing_account

OK. The request has succeeded.

Name	Datatype	Description
properties	object	Payment method properties
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /

get_by_user

OK. The request has succeeded.

Name	Datatype	Description
properties	object	Payment method properties
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /

list_by_user

OK. The request has succeeded.

Name	Datatype	Description
properties	object	Payment method properties
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_billing_profile	select	billingAccountName, billingProfileName, paymentMethodName		Gets a payment method linked with a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
list_by_billing_profile	select	billingAccountName, billingProfileName		Lists payment methods attached to a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
get_by_billing_account	select	billingAccountName, paymentMethodName		Gets a payment method available for a billing account. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
list_by_billing_account	select	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.
get_by_user	select	paymentMethodName		Gets a payment method owned by the caller.
list_by_user	select			Lists the payment methods owned by the caller.
delete_by_user	delete	paymentMethodName		Deletes a payment method owned by the caller.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
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.

SELECT examples

get_by_billing_profile

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

SELECT
properties,
tags
FROM azure.billing.payment_methods
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND billingProfileName = '{{ billingProfileName }}' -- required
AND paymentMethodName = '{{ paymentMethodName }}' -- required
;

list_by_billing_profile

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

SELECT
properties,
tags
FROM azure.billing.payment_methods
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND billingProfileName = '{{ billingProfileName }}' -- required
;

get_by_billing_account

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

SELECT
properties,
tags
FROM azure.billing.payment_methods
WHERE billingAccountName = '{{ billingAccountName }}' -- required
AND paymentMethodName = '{{ paymentMethodName }}' -- required
;

list_by_billing_account

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.

SELECT
properties,
tags
FROM azure.billing.payment_methods
WHERE billingAccountName = '{{ billingAccountName }}' -- required
;

get_by_user

Gets a payment method owned by the caller.

SELECT
properties,
tags
FROM azure.billing.payment_methods
WHERE paymentMethodName = '{{ paymentMethodName }}' -- required
;

list_by_user

Lists the payment methods owned by the caller.

SELECT
properties,
tags
FROM azure.billing.payment_methods
;

DELETE examples

delete_by_user

Deletes a payment method owned by the caller.

DELETE FROM azure.billing.payment_methods
WHERE paymentMethodName = '{{ paymentMethodName }}' --required
;