Microsoft.Billing (preview:2019-10-01)

2025/09/26 • 119 new, 119 deleted methods

BillingAccounts_List (new)
Description :  Lists the billing accounts that a user has access to.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the address, invoice sections and billing profiles. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing accounts. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing account. ,
Required: False ,
}
{
displayName:
{
Description: The billing account name. ,
Required: False ,
}
string ,
address:
{
Description: The address associated with the billing account. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
agreementType:
{
Description: The type of agreement. ,
Enum:
{
MicrosoftCustomerAgreement: No description available. ,
EnterpriseAgreement: No description available. ,
MicrosoftOnlineServicesProgram: No description available. ,
MicrosoftPartnerAgreement: No description available. ,
}
,
Required: False ,
}
enum ,
customerType:
{
Description: The type of customer. ,
Enum:
{
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
}
,
Required: False ,
}
enum ,
accountType:
{
Description: The type of customer. ,
Enum:
{
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfiles:
{
Description: The billing profiles associated with the billing account. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
poNumber:
{
Description: The purchase order name that will appear on the invoices generated for the billing profile. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
billingRelationshipType:
{
Description: Identifies which services and purchases are paid by a billing profile. ,
Enum:
{
Direct: No description available. ,
IndirectCustomer: No description available. ,
IndirectPartner: No description available. ,
CSPPartner: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceEmailOptIn:
{
Description: Flag controlling whether the invoices for the billing profile are sent through email. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: The day of the month when the invoice for the billing profile is generated. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Information about the enabled azure plans. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
indirectRelationshipInfo:
{
Description: Identifies the billing profile that is linked to another billing profile in indirect purchase motion. ,
Required: False ,
}
{
billingAccountName:
{
Description: The billing account name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The billing profile name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the partner or customer for an indirect motion. ,
Required: False ,
}
string ,
}
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an invoice section. ,
Required: False ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Enum:
{
USGov: No description available. ,
USNat: No description available. ,
USSec: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
status:
{
Description: The status of the billing profile. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
}
,
Required: False ,
}
enum ,
statusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
PastDue: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
spendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
targetClouds:
{
Description: Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
enrollmentDetails:
{
Description: The details about the associated legacy enrollment. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
startDate:
{
Description: The start date of the enrollment. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment. ,
Format: date-time ,
Required: False ,
}
string ,
currency:
{
Description: The billing currency for the enrollment. ,
Required: False ,
}
string ,
channel:
{
Description: The channel type of the enrollment. ,
Required: False ,
}
string ,
policies:
{
Description: The policies for Enterprise Agreement enrollments. ,
Required: False ,
}
{
accountOwnerViewCharges:
{
Description: The policy that controls whether Account Owners can view charges. ,
Required: False ,
}
boolean ,
departmentAdminViewCharges:
{
Description: The policy that controls whether Department Administrators can view charges. ,
Required: False ,
}
boolean ,
marketplacesEnabled:
{
Description: The policy that controls whether Azure marketplace purchases are allowed in the enrollment. ,
Required: False ,
}
boolean ,
reservedInstancesEnabled:
{
Description: The policy that controls whether Azure reservation purchases are allowed in the enrollment. ,
Required: False ,
}
boolean ,
}
,
language:
{
Description: The language for the enrollment. ,
Required: False ,
}
string ,
countryCode:
{
Description: The country code of the enrollment. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the enrollment. ,
Required: False ,
}
string ,
billingCycle:
{
Description: The billing cycle for the enrollment. ,
Required: False ,
}
string ,
}
,
departments:
{
Description: The departments associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: A department. ,
Required: False ,
}
{
departmentName:
{
Description: The name of the department. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the department. ,
Required: False ,
}
string ,
status:
{
Description: The status of the department. ,
Required: False ,
}
string ,
enrollmentAccounts:
{
Description: Associated enrollment accounts. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an enrollment account. ,
Required: False ,
}
{
accountName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The start date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
enrollmentAccounts:
{
Description: The accounts associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an enrollment account. ,
Required: False ,
}
{
accountName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The start date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
organizationId:
{
Description: Organization id. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingAccounts_Get (new)
Description :  Gets a billing account by its ID.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the address, invoice sections and billing profiles. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the billing account. ,
Required: False ,
}
{
displayName:
{
Description: The billing account name. ,
Required: False ,
}
string ,
address:
{
Description: The address associated with the billing account. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
agreementType:
{
Description: The type of agreement. ,
Enum:
{
MicrosoftCustomerAgreement: No description available. ,
EnterpriseAgreement: No description available. ,
MicrosoftOnlineServicesProgram: No description available. ,
MicrosoftPartnerAgreement: No description available. ,
}
,
Required: False ,
}
enum ,
customerType:
{
Description: The type of customer. ,
Enum:
{
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
}
,
Required: False ,
}
enum ,
accountType:
{
Description: The type of customer. ,
Enum:
{
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfiles:
{
Description: The billing profiles associated with the billing account. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
poNumber:
{
Description: The purchase order name that will appear on the invoices generated for the billing profile. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
billingRelationshipType:
{
Description: Identifies which services and purchases are paid by a billing profile. ,
Enum:
{
Direct: No description available. ,
IndirectCustomer: No description available. ,
IndirectPartner: No description available. ,
CSPPartner: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceEmailOptIn:
{
Description: Flag controlling whether the invoices for the billing profile are sent through email. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: The day of the month when the invoice for the billing profile is generated. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Information about the enabled azure plans. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
indirectRelationshipInfo:
{
Description: Identifies the billing profile that is linked to another billing profile in indirect purchase motion. ,
Required: False ,
}
{
billingAccountName:
{
Description: The billing account name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The billing profile name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the partner or customer for an indirect motion. ,
Required: False ,
}
string ,
}
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an invoice section. ,
Required: False ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Enum:
{
USGov: No description available. ,
USNat: No description available. ,
USSec: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
status:
{
Description: The status of the billing profile. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
}
,
Required: False ,
}
enum ,
statusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
PastDue: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
spendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
targetClouds:
{
Description: Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
enrollmentDetails:
{
Description: The details about the associated legacy enrollment. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
startDate:
{
Description: The start date of the enrollment. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment. ,
Format: date-time ,
Required: False ,
}
string ,
currency:
{
Description: The billing currency for the enrollment. ,
Required: False ,
}
string ,
channel:
{
Description: The channel type of the enrollment. ,
Required: False ,
}
string ,
policies:
{
Description: The policies for Enterprise Agreement enrollments. ,
Required: False ,
}
{
accountOwnerViewCharges:
{
Description: The policy that controls whether Account Owners can view charges. ,
Required: False ,
}
boolean ,
departmentAdminViewCharges:
{
Description: The policy that controls whether Department Administrators can view charges. ,
Required: False ,
}
boolean ,
marketplacesEnabled:
{
Description: The policy that controls whether Azure marketplace purchases are allowed in the enrollment. ,
Required: False ,
}
boolean ,
reservedInstancesEnabled:
{
Description: The policy that controls whether Azure reservation purchases are allowed in the enrollment. ,
Required: False ,
}
boolean ,
}
,
language:
{
Description: The language for the enrollment. ,
Required: False ,
}
string ,
countryCode:
{
Description: The country code of the enrollment. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the enrollment. ,
Required: False ,
}
string ,
billingCycle:
{
Description: The billing cycle for the enrollment. ,
Required: False ,
}
string ,
}
,
departments:
{
Description: The departments associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: A department. ,
Required: False ,
}
{
departmentName:
{
Description: The name of the department. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the department. ,
Required: False ,
}
string ,
status:
{
Description: The status of the department. ,
Required: False ,
}
string ,
enrollmentAccounts:
{
Description: Associated enrollment accounts. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an enrollment account. ,
Required: False ,
}
{
accountName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The start date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
enrollmentAccounts:
{
Description: The accounts associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an enrollment account. ,
Required: False ,
}
{
accountName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The start date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
organizationId:
{
Description: Organization id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingAccounts_Update (new)
Description :  Updates the properties of a billing account. Currently, displayName and address can be updated. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the update billing account operation. ,
Required: True ,
}
{
properties:
{
Description: A billing property. ,
Required: False ,
}
{
displayName:
{
Description: The billing account name. ,
Required: False ,
}
string ,
address:
{
Description: The address associated with the billing account. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
agreementType:
{
Description: The type of agreement. ,
Enum:
{
MicrosoftCustomerAgreement: No description available. ,
EnterpriseAgreement: No description available. ,
MicrosoftOnlineServicesProgram: No description available. ,
MicrosoftPartnerAgreement: No description available. ,
}
,
Required: False ,
}
enum ,
customerType:
{
Description: The type of customer. ,
Enum:
{
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
}
,
Required: False ,
}
enum ,
accountType:
{
Description: The type of customer. ,
Enum:
{
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfiles:
{
Description: The billing profiles associated with the billing account. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
poNumber:
{
Description: The purchase order name that will appear on the invoices generated for the billing profile. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
billingRelationshipType:
{
Description: Identifies which services and purchases are paid by a billing profile. ,
Enum:
{
Direct: No description available. ,
IndirectCustomer: No description available. ,
IndirectPartner: No description available. ,
CSPPartner: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceEmailOptIn:
{
Description: Flag controlling whether the invoices for the billing profile are sent through email. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: The day of the month when the invoice for the billing profile is generated. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Information about the enabled azure plans. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
indirectRelationshipInfo:
{
Description: Identifies the billing profile that is linked to another billing profile in indirect purchase motion. ,
Required: False ,
}
{
billingAccountName:
{
Description: The billing account name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The billing profile name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the partner or customer for an indirect motion. ,
Required: False ,
}
string ,
}
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an invoice section. ,
Required: False ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Enum:
{
USGov: No description available. ,
USNat: No description available. ,
USSec: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
status:
{
Description: The status of the billing profile. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
}
,
Required: False ,
}
enum ,
statusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
PastDue: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
spendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
targetClouds:
{
Description: Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
enrollmentDetails:
{
Description: The details about the associated legacy enrollment. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
startDate:
{
Description: The start date of the enrollment. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment. ,
Format: date-time ,
Required: False ,
}
string ,
currency:
{
Description: The billing currency for the enrollment. ,
Required: False ,
}
string ,
channel:
{
Description: The channel type of the enrollment. ,
Required: False ,
}
string ,
policies:
{
Description: The policies for Enterprise Agreement enrollments. ,
Required: False ,
}
{
accountOwnerViewCharges:
{
Description: The policy that controls whether Account Owners can view charges. ,
Required: False ,
}
boolean ,
departmentAdminViewCharges:
{
Description: The policy that controls whether Department Administrators can view charges. ,
Required: False ,
}
boolean ,
marketplacesEnabled:
{
Description: The policy that controls whether Azure marketplace purchases are allowed in the enrollment. ,
Required: False ,
}
boolean ,
reservedInstancesEnabled:
{
Description: The policy that controls whether Azure reservation purchases are allowed in the enrollment. ,
Required: False ,
}
boolean ,
}
,
language:
{
Description: The language for the enrollment. ,
Required: False ,
}
string ,
countryCode:
{
Description: The country code of the enrollment. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the enrollment. ,
Required: False ,
}
string ,
billingCycle:
{
Description: The billing cycle for the enrollment. ,
Required: False ,
}
string ,
}
,
departments:
{
Description: The departments associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: A department. ,
Required: False ,
}
{
departmentName:
{
Description: The name of the department. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the department. ,
Required: False ,
}
string ,
status:
{
Description: The status of the department. ,
Required: False ,
}
string ,
enrollmentAccounts:
{
Description: Associated enrollment accounts. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an enrollment account. ,
Required: False ,
}
{
accountName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The start date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
enrollmentAccounts:
{
Description: The accounts associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an enrollment account. ,
Required: False ,
}
{
accountName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The start date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
organizationId:
{
Description: Organization id. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the billing account. ,
Required: False ,
}
{
displayName:
{
Description: The billing account name. ,
Required: False ,
}
string ,
address:
{
Description: The address associated with the billing account. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
agreementType:
{
Description: The type of agreement. ,
Enum:
{
MicrosoftCustomerAgreement: No description available. ,
EnterpriseAgreement: No description available. ,
MicrosoftOnlineServicesProgram: No description available. ,
MicrosoftPartnerAgreement: No description available. ,
}
,
Required: False ,
}
enum ,
customerType:
{
Description: The type of customer. ,
Enum:
{
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
}
,
Required: False ,
}
enum ,
accountType:
{
Description: The type of customer. ,
Enum:
{
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfiles:
{
Description: The billing profiles associated with the billing account. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
poNumber:
{
Description: The purchase order name that will appear on the invoices generated for the billing profile. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
billingRelationshipType:
{
Description: Identifies which services and purchases are paid by a billing profile. ,
Enum:
{
Direct: No description available. ,
IndirectCustomer: No description available. ,
IndirectPartner: No description available. ,
CSPPartner: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceEmailOptIn:
{
Description: Flag controlling whether the invoices for the billing profile are sent through email. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: The day of the month when the invoice for the billing profile is generated. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Information about the enabled azure plans. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
indirectRelationshipInfo:
{
Description: Identifies the billing profile that is linked to another billing profile in indirect purchase motion. ,
Required: False ,
}
{
billingAccountName:
{
Description: The billing account name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The billing profile name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the partner or customer for an indirect motion. ,
Required: False ,
}
string ,
}
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an invoice section. ,
Required: False ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Enum:
{
USGov: No description available. ,
USNat: No description available. ,
USSec: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
status:
{
Description: The status of the billing profile. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
}
,
Required: False ,
}
enum ,
statusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
PastDue: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
spendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
targetClouds:
{
Description: Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
enrollmentDetails:
{
Description: The details about the associated legacy enrollment. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
startDate:
{
Description: The start date of the enrollment. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment. ,
Format: date-time ,
Required: False ,
}
string ,
currency:
{
Description: The billing currency for the enrollment. ,
Required: False ,
}
string ,
channel:
{
Description: The channel type of the enrollment. ,
Required: False ,
}
string ,
policies:
{
Description: The policies for Enterprise Agreement enrollments. ,
Required: False ,
}
{
accountOwnerViewCharges:
{
Description: The policy that controls whether Account Owners can view charges. ,
Required: False ,
}
boolean ,
departmentAdminViewCharges:
{
Description: The policy that controls whether Department Administrators can view charges. ,
Required: False ,
}
boolean ,
marketplacesEnabled:
{
Description: The policy that controls whether Azure marketplace purchases are allowed in the enrollment. ,
Required: False ,
}
boolean ,
reservedInstancesEnabled:
{
Description: The policy that controls whether Azure reservation purchases are allowed in the enrollment. ,
Required: False ,
}
boolean ,
}
,
language:
{
Description: The language for the enrollment. ,
Required: False ,
}
string ,
countryCode:
{
Description: The country code of the enrollment. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the enrollment. ,
Required: False ,
}
string ,
billingCycle:
{
Description: The billing cycle for the enrollment. ,
Required: False ,
}
string ,
}
,
departments:
{
Description: The departments associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: A department. ,
Required: False ,
}
{
departmentName:
{
Description: The name of the department. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the department. ,
Required: False ,
}
string ,
status:
{
Description: The status of the department. ,
Required: False ,
}
string ,
enrollmentAccounts:
{
Description: Associated enrollment accounts. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an enrollment account. ,
Required: False ,
}
{
accountName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The start date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
enrollmentAccounts:
{
Description: The accounts associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an enrollment account. ,
Required: False ,
}
{
accountName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The start date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
organizationId:
{
Description: Organization id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingAccounts_ListInvoiceSectionsByCreateSubscriptionPermission (new)
Description :  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.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/listInvoiceSectionsWithCreateSubscriptionPermission
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of invoice section properties with create subscription permission. ,
Required: False ,
}
[
{
invoiceSectionId:
{
Description: The ID of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile for the invoice section. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile for the invoice section. ,
Required: False ,
}
string ,
billingProfileStatus:
{
Description: The status of the billing profile. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfileStatusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
PastDue: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfileSpendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
enabledAzurePlans:
{
Description: Enabled azure plans for the associated billing profile. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
PaymentMethods_ListByBillingAccount (new)
Description :  Lists the payment Methods for a billing account. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/paymentMethods
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of payment methods. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a payment method. ,
Required: False ,
}
{
paymentMethodType:
{
Description: The type of payment method. ,
Enum:
{
Credits: No description available. ,
ChequeWire: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Details about the payment method. ,
Required: False ,
}
string ,
expiration:
{
Description: Expiration month and year. ,
Required: False ,
}
string ,
currency:
{
Description: The currency associated with the payment method. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Address_Validate (new)
Description :  Validates an address. Use the operation to validate an address before using it as a billing account or a billing profile address.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/validateAddress
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
address:
{
Required: True ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
status:
{
Description: status of the address validation. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
suggestedAddresses:
{
Description: The list of suggested addresses. ,
Required: False ,
}
[
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
]
,
validationMessage:
{
Description: Validation error message. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
AvailableBalances_GetByBillingProfile (new)
Description :  The available credit balance for a billing profile. This is the balance that can be used for pay now to settle due or past due invoices. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/availableBalance/default
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of available balance. ,
Required: False ,
}
{
amount:
{
Description: Balance amount. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Instructions_ListByBillingProfile (new)
Description :  Lists the instructions by billing profile id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/instructions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing instructions used during invoice generation. ,
Required: False ,
}
[
{
properties:
{
Description: A billing instruction used during invoice generation. ,
Required: False ,
}
{
amount:
{
Description: The amount budgeted for this billing instruction. ,
Required: True ,
}
number ,
startDate:
{
Description: The date this billing instruction goes into effect. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The date this billing instruction is no longer in effect. ,
Format: date-time ,
Required: True ,
}
string ,
creationDate:
{
Description: The date this billing instruction was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Instructions_Get (new)
Description :  Get the instruction by name. These are custom billing instructions and are only applicable for certain customers.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/instructions/{instructionName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
instructionName:
{
Description: Instruction Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A billing instruction used during invoice generation. ,
Required: False ,
}
{
amount:
{
Description: The amount budgeted for this billing instruction. ,
Required: True ,
}
number ,
startDate:
{
Description: The date this billing instruction goes into effect. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The date this billing instruction is no longer in effect. ,
Format: date-time ,
Required: True ,
}
string ,
creationDate:
{
Description: The date this billing instruction was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Instructions_Put (new)
Description :  Creates or updates an instruction. These are custom billing instructions and are only applicable for certain customers.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/instructions/{instructionName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
instructionName:
{
Description: Instruction Name. ,
Required: True ,
}
string ,
parameters:
{
Description: The new instruction. ,
Required: True ,
}
{
properties:
{
Description: A billing instruction used during invoice generation. ,
Required: False ,
}
{
amount:
{
Description: The amount budgeted for this billing instruction. ,
Required: True ,
}
number ,
startDate:
{
Description: The date this billing instruction goes into effect. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The date this billing instruction is no longer in effect. ,
Format: date-time ,
Required: True ,
}
string ,
creationDate:
{
Description: The date this billing instruction was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A billing instruction used during invoice generation. ,
Required: False ,
}
{
amount:
{
Description: The amount budgeted for this billing instruction. ,
Required: True ,
}
number ,
startDate:
{
Description: The date this billing instruction goes into effect. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The date this billing instruction is no longer in effect. ,
Format: date-time ,
Required: True ,
}
string ,
creationDate:
{
Description: The date this billing instruction was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
PaymentMethods_ListByBillingProfile (new)
Description :  Lists the payment Methods for a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/paymentMethods
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of payment methods. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a payment method. ,
Required: False ,
}
{
paymentMethodType:
{
Description: The type of payment method. ,
Enum:
{
Credits: No description available. ,
ChequeWire: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Details about the payment method. ,
Required: False ,
}
string ,
expiration:
{
Description: Expiration month and year. ,
Required: False ,
}
string ,
currency:
{
Description: The currency associated with the payment method. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingProfiles_GetEligibilityToDetachPaymentMethod (new)
Description :  Validates if the default payment method can be detached from the billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/validateDetachPaymentMethodEligibility
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
isEligible:
{
Description: Specifies whether the payment method is eligible to be detached from the billing profile. ,
Required: False ,
}
boolean ,
errorDetails:
{
Description: The list of detach payment method eligibility errors. ,
Required: False ,
}
[
{
code:
{
Description: Error code for the detach payment method eligibility validation. ,
Enum:
{
AzureSubscriptions: No description available. ,
RecurringCharges: No description available. ,
ReservedInstances: No description available. ,
OutstandingCharges: No description available. ,
PendingCharges: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Error message for the detach payment method eligibility validation. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingProfiles_ListByBillingAccount (new)
Description :  Lists the billing profiles that a user has access to. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the invoice sections. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing profiles. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
poNumber:
{
Description: The purchase order name that will appear on the invoices generated for the billing profile. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
billingRelationshipType:
{
Description: Identifies which services and purchases are paid by a billing profile. ,
Enum:
{
Direct: No description available. ,
IndirectCustomer: No description available. ,
IndirectPartner: No description available. ,
CSPPartner: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceEmailOptIn:
{
Description: Flag controlling whether the invoices for the billing profile are sent through email. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: The day of the month when the invoice for the billing profile is generated. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Information about the enabled azure plans. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
indirectRelationshipInfo:
{
Description: Identifies the billing profile that is linked to another billing profile in indirect purchase motion. ,
Required: False ,
}
{
billingAccountName:
{
Description: The billing account name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The billing profile name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the partner or customer for an indirect motion. ,
Required: False ,
}
string ,
}
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an invoice section. ,
Required: False ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Enum:
{
USGov: No description available. ,
USNat: No description available. ,
USSec: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
status:
{
Description: The status of the billing profile. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
}
,
Required: False ,
}
enum ,
statusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
PastDue: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
spendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
targetClouds:
{
Description: Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingProfiles_Get (new)
Description :  Gets a billing profile by its ID. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the invoice sections. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
poNumber:
{
Description: The purchase order name that will appear on the invoices generated for the billing profile. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
billingRelationshipType:
{
Description: Identifies which services and purchases are paid by a billing profile. ,
Enum:
{
Direct: No description available. ,
IndirectCustomer: No description available. ,
IndirectPartner: No description available. ,
CSPPartner: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceEmailOptIn:
{
Description: Flag controlling whether the invoices for the billing profile are sent through email. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: The day of the month when the invoice for the billing profile is generated. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Information about the enabled azure plans. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
indirectRelationshipInfo:
{
Description: Identifies the billing profile that is linked to another billing profile in indirect purchase motion. ,
Required: False ,
}
{
billingAccountName:
{
Description: The billing account name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The billing profile name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the partner or customer for an indirect motion. ,
Required: False ,
}
string ,
}
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an invoice section. ,
Required: False ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Enum:
{
USGov: No description available. ,
USNat: No description available. ,
USSec: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
status:
{
Description: The status of the billing profile. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
}
,
Required: False ,
}
enum ,
statusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
PastDue: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
spendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
targetClouds:
{
Description: Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingProfiles_Create (new)
Description :  Creates a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the create billing profile operation. ,
Required: True ,
}
{
displayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
poNumber:
{
Description: The purchase order name that will appear on the invoices generated for the billing profile. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: Flag controlling whether the invoices for the billing profile are sent through email. ,
Required: False ,
}
boolean ,
enabledAzurePlans:
{
Description: Enabled azure plans for the billing profile. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
poNumber:
{
Description: The purchase order name that will appear on the invoices generated for the billing profile. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
billingRelationshipType:
{
Description: Identifies which services and purchases are paid by a billing profile. ,
Enum:
{
Direct: No description available. ,
IndirectCustomer: No description available. ,
IndirectPartner: No description available. ,
CSPPartner: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceEmailOptIn:
{
Description: Flag controlling whether the invoices for the billing profile are sent through email. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: The day of the month when the invoice for the billing profile is generated. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Information about the enabled azure plans. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
indirectRelationshipInfo:
{
Description: Identifies the billing profile that is linked to another billing profile in indirect purchase motion. ,
Required: False ,
}
{
billingAccountName:
{
Description: The billing account name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The billing profile name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the partner or customer for an indirect motion. ,
Required: False ,
}
string ,
}
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an invoice section. ,
Required: False ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Enum:
{
USGov: No description available. ,
USNat: No description available. ,
USSec: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
status:
{
Description: The status of the billing profile. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
}
,
Required: False ,
}
enum ,
statusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
PastDue: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
spendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
targetClouds:
{
Description: Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result ,
}
string ,
retry-after:
{
Description: Recommended time to wait before making another request to check the status of the operation. The time is specified in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingProfiles_Update (new)
Description :  Updates the properties of a billing profile. Currently, displayName, poNumber, bill-to address and invoiceEmailOptIn can be updated. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters supplied to the update billing profile operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of the billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
poNumber:
{
Description: The purchase order name that will appear on the invoices generated for the billing profile. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
billingRelationshipType:
{
Description: Identifies which services and purchases are paid by a billing profile. ,
Enum:
{
Direct: No description available. ,
IndirectCustomer: No description available. ,
IndirectPartner: No description available. ,
CSPPartner: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceEmailOptIn:
{
Description: Flag controlling whether the invoices for the billing profile are sent through email. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: The day of the month when the invoice for the billing profile is generated. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Information about the enabled azure plans. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
indirectRelationshipInfo:
{
Description: Identifies the billing profile that is linked to another billing profile in indirect purchase motion. ,
Required: False ,
}
{
billingAccountName:
{
Description: The billing account name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The billing profile name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the partner or customer for an indirect motion. ,
Required: False ,
}
string ,
}
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an invoice section. ,
Required: False ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Enum:
{
USGov: No description available. ,
USNat: No description available. ,
USSec: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
status:
{
Description: The status of the billing profile. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
}
,
Required: False ,
}
enum ,
statusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
PastDue: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
spendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
targetClouds:
{
Description: Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
poNumber:
{
Description: The purchase order name that will appear on the invoices generated for the billing profile. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
billingRelationshipType:
{
Description: Identifies which services and purchases are paid by a billing profile. ,
Enum:
{
Direct: No description available. ,
IndirectCustomer: No description available. ,
IndirectPartner: No description available. ,
CSPPartner: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceEmailOptIn:
{
Description: Flag controlling whether the invoices for the billing profile are sent through email. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: The day of the month when the invoice for the billing profile is generated. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Information about the enabled azure plans. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
indirectRelationshipInfo:
{
Description: Identifies the billing profile that is linked to another billing profile in indirect purchase motion. ,
Required: False ,
}
{
billingAccountName:
{
Description: The billing account name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The billing profile name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the partner or customer for an indirect motion. ,
Required: False ,
}
string ,
}
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an invoice section. ,
Required: False ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Enum:
{
USGov: No description available. ,
USNat: No description available. ,
USSec: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
status:
{
Description: The status of the billing profile. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
}
,
Required: False ,
}
enum ,
statusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
PastDue: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
spendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
targetClouds:
{
Description: Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: GET this URL to retrieve the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Customers_ListByBillingProfile (new)
Description :  Lists the customers that are billed to a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter the list of customers. ,
Required: False ,
}
string ,
$skiptoken:
{
Description: Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of customers. ,
Required: False ,
}
[
{
properties:
{
Description: The customer. ,
Required: False ,
}
{
displayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Azure plans enabled for the customer. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
resellers:
{
Description: The list of resellers for which an Azure plan is enabled for the customer. ,
Required: False ,
}
[
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
InvoiceSections_ListByBillingProfile (new)
Description :  Lists the invoice sections that a user has access to. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of invoice sections. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an invoice section. ,
Required: False ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Enum:
{
USGov: No description available. ,
USNat: No description available. ,
USSec: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
InvoiceSections_Get (new)
Description :  Gets an invoice section by its ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an invoice section. ,
Required: False ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Enum:
{
USGov: No description available. ,
USNat: No description available. ,
USSec: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
InvoiceSections_Create (new)
Description :  Creates an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the create invoice section operation. ,
Required: True ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an invoice section. ,
Required: False ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Enum:
{
USGov: No description available. ,
USNat: No description available. ,
USSec: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result ,
}
string ,
retry-after:
{
Description: Recommended time to wait before making another request to check the status of the operation. The time is specified in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
InvoiceSections_Update (new)
Description :  Updates an invoice section. Currently, only displayName can be updated. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the update invoice section operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of an invoice section. ,
Required: False ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Enum:
{
USGov: No description available. ,
USNat: No description available. ,
USSec: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an invoice section. ,
Required: False ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Enum:
{
USGov: No description available. ,
USNat: No description available. ,
USSec: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: GET this URL to retrieve the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Customers_ListByBillingAccount (new)
Description :  Lists the customers that are billed to a billing account. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter the list of customers. ,
Required: False ,
}
string ,
$skiptoken:
{
Description: Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of customers. ,
Required: False ,
}
[
{
properties:
{
Description: The customer. ,
Required: False ,
}
{
displayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Azure plans enabled for the customer. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
resellers:
{
Description: The list of resellers for which an Azure plan is enabled for the customer. ,
Required: False ,
}
[
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Customers_Get (new)
Description :  Gets a customer by its ID. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand enabledAzurePlans and resellers ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The customer. ,
Required: False ,
}
{
displayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Azure plans enabled for the customer. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
resellers:
{
Description: The list of resellers for which an Azure plan is enabled for the customer. ,
Required: False ,
}
[
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingPermissions_ListByCustomer (new)
Description :  Lists the billing permissions the caller has for a customer.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/billingPermissions
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billingPermissions a caller has on a billing account. ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingSubscriptions_ListByCustomer (new)
Description :  Lists the subscriptions for a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/billingSubscriptions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing subscriptions. ,
Required: False ,
}
[
{
properties:
{
Description: The billing properties of a subscription. ,
Required: False ,
}
{
displayName:
{
Description: The name of the subscription. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription. ,
Format: uuid ,
Required: False ,
}
string ,
subscriptionBillingStatus:
{
Description: The current billing status of the subscription. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
Abandoned: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
lastMonthCharges:
{
Description: The last month charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billingProfileId:
{
Description: The ID of the billing profile to which the subscription is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the subscription is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the subscription is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the subscription is billed. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this subscription. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The sku ID of the Azure plan for the subscription. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the Azure plan for the subscription. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingSubscriptions_GetByCustomer (new)
Description :  Gets a subscription by its ID. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/billingSubscriptions/{billingSubscriptionName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: The ID that uniquely identifies a subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The billing properties of a subscription. ,
Required: False ,
}
{
displayName:
{
Description: The name of the subscription. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription. ,
Format: uuid ,
Required: False ,
}
string ,
subscriptionBillingStatus:
{
Description: The current billing status of the subscription. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
Abandoned: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
lastMonthCharges:
{
Description: The last month charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billingProfileId:
{
Description: The ID of the billing profile to which the subscription is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the subscription is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the subscription is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the subscription is billed. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this subscription. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The sku ID of the Azure plan for the subscription. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the Azure plan for the subscription. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Products_ListByCustomer (new)
Description :  Lists the products for a customer. These don't include products billed based on usage.The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/products
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter by product type. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value are separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of products. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a product. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date when the product was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the type of product. ,
Required: False ,
}
string ,
productType:
{
Description: The description of the type of product. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the product. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
PastDue: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
Disabled: No description available. ,
Cancelled: No description available. ,
AutoRenew: No description available. ,
}
,
Required: False ,
}
enum ,
endDate:
{
Description: The date when the product will be renewed or canceled. ,
Format: date-time ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The frequency at which the product will be billed. ,
Enum:
{
OneTime: No description available. ,
Monthly: No description available. ,
UsageBased: No description available. ,
}
,
Required: False ,
}
enum ,
lastCharge:
{
Description: The last month charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
lastChargeDate:
{
Description: The date of the last charge. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased for the product. ,
Required: False ,
}
number ,
skuId:
{
Description: The sku ID of the product. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the product. ,
Required: False ,
}
string ,
tenantId:
{
Description: The id of the tenant in which the product is used. ,
Required: False ,
}
string ,
availabilityId:
{
Description: The availability of the product. ,
Required: False ,
}
string ,
parentProductId:
{
Description: Parent product Id. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this product. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Products_GetByCustomer (new)
Description :  Gets a product by ID. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/products/{productName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
productName:
{
Description: The ID that uniquely identifies a product. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a product. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date when the product was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the type of product. ,
Required: False ,
}
string ,
productType:
{
Description: The description of the type of product. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the product. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
PastDue: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
Disabled: No description available. ,
Cancelled: No description available. ,
AutoRenew: No description available. ,
}
,
Required: False ,
}
enum ,
endDate:
{
Description: The date when the product will be renewed or canceled. ,
Format: date-time ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The frequency at which the product will be billed. ,
Enum:
{
OneTime: No description available. ,
Monthly: No description available. ,
UsageBased: No description available. ,
}
,
Required: False ,
}
enum ,
lastCharge:
{
Description: The last month charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
lastChargeDate:
{
Description: The date of the last charge. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased for the product. ,
Required: False ,
}
number ,
skuId:
{
Description: The sku ID of the product. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the product. ,
Required: False ,
}
string ,
tenantId:
{
Description: The id of the tenant in which the product is used. ,
Required: False ,
}
string ,
availabilityId:
{
Description: The availability of the product. ,
Required: False ,
}
string ,
parentProductId:
{
Description: Parent product Id. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this product. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Transactions_ListByCustomer (new)
Description :  Lists the billed and unbilled transactions by customer id for given start date and end date. Transactions include purchases, refunds and Azure usage charges. Unbilled transactions are listed under pending invoice Id and do not include tax. Tax is added to the amount once an invoice is generated.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/transactions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Required: True ,
}
string ,
periodEndDate:
{
Description: The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter by transaction type. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value are separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of transactions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a transaction. ,
Required: False ,
}
{
kind:
{
Description: The kind of transaction. Options are all or reservation. ,
Enum:
{
all: No description available. ,
reservation: No description available. ,
}
,
Required: False ,
}
enum ,
date:
{
Description: The date of transaction. ,
Format: date-time ,
Required: False ,
}
string ,
invoice:
{
Description: Invoice on which the transaction was billed or 'pending' if the transaction is not billed. ,
Required: False ,
}
string ,
orderId:
{
Description: The order ID of the reservation. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
orderName:
{
Description: The name of the reservation order. The field is only applicable for transactions of kind reservation. ,
Required: False ,
}
string ,
productFamily:
{
Description: The family of the product for which the transaction took place. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product type for which the transaction took place. ,
Required: False ,
}
string ,
productType:
{
Description: The type of the product for which the transaction took place. ,
Required: False ,
}
string ,
productDescription:
{
Description: The description of the product for which the transaction took place. ,
Required: False ,
}
string ,
transactionType:
{
Description: The type of transaction. ,
Enum:
{
Purchase: No description available. ,
Usage Charge: No description available. ,
}
,
Required: False ,
}
enum ,
transactionAmount:
{
Description: The charge associated with the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
quantity:
{
Description: The quantity purchased in the transaction. ,
Format: int32 ,
Required: False ,
}
integer ,
invoiceSectionId:
{
Description: The ID of the invoice section which will be billed for the transaction. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section which will be billed for the transaction. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile which will be billed for the transaction. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile which will be billed for the transaction. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The name of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
azureCreditApplied:
{
Description: The amount of any Azure credits automatically applied to this transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billingCurrency:
{
Description: The ISO 4217 code for the currency in which this transaction is billed. ,
Required: False ,
}
string ,
discount:
{
Description: The percentage discount, if any, applied to this transaction. ,
Required: False ,
}
number ,
effectivePrice:
{
Description: The price of the product after applying any discounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
exchangeRate:
{
Description: The exchange rate used to convert charged amount to billing currency, if applicable. ,
Required: False ,
}
number ,
marketPrice:
{
Description: The retail price of the product. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
pricingCurrency:
{
Description: The ISO 4217 code for the currency in which the product is priced. ,
Required: False ,
}
string ,
servicePeriodStartDate:
{
Description: The date of the purchase of the product, or the start date of the month in which usage started. ,
Format: date-time ,
Required: False ,
}
string ,
servicePeriodEndDate:
{
Description: The end date of the product term, or the end date of the month in which usage ended. ,
Format: date-time ,
Required: False ,
}
string ,
subTotal:
{
Description: The pre-tax charged amount for the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
tax:
{
Description: The tax amount applied to the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
unitOfMeasure:
{
Description: The unit of measure used to bill for the product. For example, compute services are billed per hour. ,
Required: False ,
}
string ,
units:
{
Description: The number of units used for a given product. ,
Required: False ,
}
number ,
unitType:
{
Description: The description for the unit of measure for a given product. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Departments_ListByBillingAccountName (new)
Description :  Lists the departments that a user has access to. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the enrollment accounts. ,
Required: False ,
}
string ,
$filter:
{
Description: May be used to filter by department name. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value are separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of departments. ,
Required: False ,
}
[
{
properties:
{
Description: A department. ,
Required: False ,
}
{
departmentName:
{
Description: The name of the department. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the department. ,
Required: False ,
}
string ,
status:
{
Description: The status of the department. ,
Required: False ,
}
string ,
enrollmentAccounts:
{
Description: Associated enrollment accounts. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an enrollment account. ,
Required: False ,
}
{
accountName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The start date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Departments_Get (new)
Description :  Gets a department by ID. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
departmentName:
{
Description: The ID that uniquely identifies a department. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the enrollment accounts. ,
Required: False ,
}
string ,
$filter:
{
Description: May be used to filter by department name. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value are separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A department. ,
Required: False ,
}
{
departmentName:
{
Description: The name of the department. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the department. ,
Required: False ,
}
string ,
status:
{
Description: The status of the department. ,
Required: False ,
}
string ,
enrollmentAccounts:
{
Description: Associated enrollment accounts. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an enrollment account. ,
Required: False ,
}
{
accountName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The start date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
EnrollmentAccounts_ListByBillingAccountName (new)
Description :  Lists the enrollment accounts for a billing account. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the department. ,
Required: False ,
}
string ,
$filter:
{
Description: May be used to filter by account name. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value are separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of enrollment accounts. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an enrollment account. ,
Required: False ,
}
{
accountName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The start date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
EnrollmentAccounts_GetByEnrollmentAccountId (new)
Description :  Gets an enrollment account by ID. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
enrollmentAccountName:
{
Description: The ID that uniquely identifies an enrollment account. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the department. ,
Required: False ,
}
string ,
$filter:
{
Description: May be used to filter by account name. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value are separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an enrollment account. ,
Required: False ,
}
{
accountName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The start date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Invoices_ListByBillingAccount (new)
Description :  Lists the invoices for a billing account for a given start date and end date. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: The start date to fetch the invoices. The date should be specified in MM-DD-YYYY format. ,
Required: True ,
}
string ,
periodEndDate:
{
Description: The end date to fetch the invoices. The date should be specified in MM-DD-YYYY format. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of invoices. ,
Required: False ,
}
[
{
properties:
{
Description: An invoice. ,
Required: False ,
}
{
dueDate:
{
Description: The due date for the invoice. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceDate:
{
Description: The date when the invoice was generated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the invoice. ,
Enum:
{
Due: No description available. ,
OverDue: No description available. ,
Paid: No description available. ,
Void: No description available. ,
}
,
Required: False ,
}
enum ,
amountDue:
{
Description: The amount due as of now. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
azurePrepaymentApplied:
{
Description: The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billedAmount:
{
Description: The total charges for the invoice billing period. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
creditAmount:
{
Description: 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. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
freeAzureCreditApplied:
{
Description: The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
subTotal:
{
Description: The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
taxAmount:
{
Description: The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
totalAmount:
{
Description: The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
invoicePeriodStartDate:
{
Description: The start date of the billing period for which the invoice is generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end date of the billing period for which the invoice is generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceType:
{
Description: Invoice type. ,
Enum:
{
AzureService: No description available. ,
AzureMarketplace: No description available. ,
AzureSupport: No description available. ,
}
,
Required: False ,
}
enum ,
isMonthlyInvoice:
{
Description: Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
boolean ,
billingProfileId:
{
Description: The ID of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
purchaseOrderNumber:
{
Description: An optional purchase order number for the invoice. ,
Required: False ,
}
string ,
documents:
{
Description: List of documents available to download such as invoice and tax receipt. ,
Required: False ,
}
[
{
kind:
{
Description: The type of the document. ,
Enum:
{
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: Document URL. ,
Required: False ,
}
string ,
documentNumbers:
{
Description: Document numbers for an Enterprise Agreement invoice. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
payments:
{
Description: List of payments. ,
Required: False ,
}
[
{
paymentType:
{
Description: The type of payment. ,
Required: False ,
}
string ,
amount:
{
Description: The paid amount. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
date:
{
Description: The date when the payment was made. ,
Format: date-time ,
Required: False ,
}
string ,
paymentMethodFamily:
{
Description: The family of payment method. ,
Enum:
{
Credits: No description available. ,
CheckWire: No description available. ,
CreditCard: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
}
,
]
,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
Required: False ,
}
string ,
rebillDetails:
{
Description: Rebill details of an Enterprise Agreement invoice. ,
Required: False ,
}
{
rebillDocumentType:
{
Description: The type of the document generated when an Enterprise Agreement invoice is rebilled. ,
Enum:
{
Credit: No description available. ,
Rebill: No description available. ,
Original: No description available. ,
}
,
Required: False ,
}
enum ,
rebilledInvoiceId:
{
Description: The ID of the invoice generated when an Enterprise Agreement invoice is rebilled. ,
Required: False ,
}
string ,
latestInvoiceId:
{
Description: The ID of the latest invoice generated when an Enterprise Agreement invoice is rebilled. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Invoices_DownloadMultipleEAInvoices (new)
Description :  Gets a URL to download multiple invoice documents (invoice pdf, tax receipts, credit notes) as a zip file.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/downloadDocuments
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
downloadUrls:
{
Description: An array of download urls for individual documents. The download url paths in the request body should match the path of the original request. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: GET this URL to retrieve the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
string ,
}

⚐ Response (200)

{
expiryTime:
{
Description: The time in UTC when the download URL will expire. ,
Format: date-time ,
Required: False ,
}
string ,
url:
{
Description: The URL to the PDF file. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Invoices_GetBillingAccountInvoice (new)
Description :  Gets an invoice by billing account name and ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
invoiceName:
{
Description: The ID that uniquely identifies an invoice. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: An invoice. ,
Required: False ,
}
{
dueDate:
{
Description: The due date for the invoice. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceDate:
{
Description: The date when the invoice was generated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the invoice. ,
Enum:
{
Due: No description available. ,
OverDue: No description available. ,
Paid: No description available. ,
Void: No description available. ,
}
,
Required: False ,
}
enum ,
amountDue:
{
Description: The amount due as of now. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
azurePrepaymentApplied:
{
Description: The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billedAmount:
{
Description: The total charges for the invoice billing period. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
creditAmount:
{
Description: 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. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
freeAzureCreditApplied:
{
Description: The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
subTotal:
{
Description: The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
taxAmount:
{
Description: The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
totalAmount:
{
Description: The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
invoicePeriodStartDate:
{
Description: The start date of the billing period for which the invoice is generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end date of the billing period for which the invoice is generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceType:
{
Description: Invoice type. ,
Enum:
{
AzureService: No description available. ,
AzureMarketplace: No description available. ,
AzureSupport: No description available. ,
}
,
Required: False ,
}
enum ,
isMonthlyInvoice:
{
Description: Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
boolean ,
billingProfileId:
{
Description: The ID of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
purchaseOrderNumber:
{
Description: An optional purchase order number for the invoice. ,
Required: False ,
}
string ,
documents:
{
Description: List of documents available to download such as invoice and tax receipt. ,
Required: False ,
}
[
{
kind:
{
Description: The type of the document. ,
Enum:
{
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: Document URL. ,
Required: False ,
}
string ,
documentNumbers:
{
Description: Document numbers for an Enterprise Agreement invoice. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
payments:
{
Description: List of payments. ,
Required: False ,
}
[
{
paymentType:
{
Description: The type of payment. ,
Required: False ,
}
string ,
amount:
{
Description: The paid amount. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
date:
{
Description: The date when the payment was made. ,
Format: date-time ,
Required: False ,
}
string ,
paymentMethodFamily:
{
Description: The family of payment method. ,
Enum:
{
Credits: No description available. ,
CheckWire: No description available. ,
CreditCard: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
}
,
]
,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
Required: False ,
}
string ,
rebillDetails:
{
Description: Rebill details of an Enterprise Agreement invoice. ,
Required: False ,
}
{
rebillDocumentType:
{
Description: The type of the document generated when an Enterprise Agreement invoice is rebilled. ,
Enum:
{
Credit: No description available. ,
Rebill: No description available. ,
Original: No description available. ,
}
,
Required: False ,
}
enum ,
rebilledInvoiceId:
{
Description: The ID of the invoice generated when an Enterprise Agreement invoice is rebilled. ,
Required: False ,
}
string ,
latestInvoiceId:
{
Description: The ID of the latest invoice generated when an Enterprise Agreement invoice is rebilled. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Invoices_DownloadMultipleBillingSubscriptionInvoices (new)
Description :  Gets a URL to download multiple invoice documents (invoice pdf, tax receipts, credit notes) as a zip file.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/downloadDocuments
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID that uniquely identifies an Azure subscription. ,
Required: True ,
}
string ,
downloadUrls:
{
Description: An array of download urls for individual documents. The download url paths in the request body should match the path of the original request. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: GET this URL to retrieve the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
string ,
}

⚐ Response (200)

{
expiryTime:
{
Description: The time in UTC when the download URL will expire. ,
Format: date-time ,
Required: False ,
}
string ,
url:
{
Description: The URL to the PDF file. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
PriceSheet_Download (new)
Description :  Gets a URL to download the pricesheet for an invoice. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices/{invoiceName}/pricesheet/default/download
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceName:
{
Description: The ID that uniquely identifies an invoice. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: GET this URL to retrieve the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
string ,
odata-entityid:
{
Description: The operation entity Id GUID. ,
}
string ,
}

⚐ Response (200)

{
expiryTime:
{
Description: The time in UTC when the download URL will expire. ,
Format: date-time ,
Required: False ,
}
string ,
url:
{
Description: The URL to the PDF file. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
PriceSheet_DownloadByBillingProfile (new)
Description :  Gets a URL to download the current month's pricesheet for a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.This API is hereby deprecated in favor of https://docs.microsoft.com/en-us/rest/api/cost-management/2022-02-01-preview/price-sheet/download-by-billing-profile. We highly recommend you move to the new preview version, as the csv file in the current preview version will have 500k max size that cannot scale with Azure product growth.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/pricesheet/default/download
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: GET this URL to retrieve the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
string ,
odata-entityid:
{
Description: The operation entity Id GUID. ,
}
string ,
}

⚐ Response (200)

{
expiryTime:
{
Description: The time in UTC when the download URL will expire. ,
Format: date-time ,
Required: False ,
}
string ,
url:
{
Description: The URL to the PDF file. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Invoices_ListByBillingProfile (new)
Description :  Lists the invoices for a billing profile for a given start date and end date. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: The start date to fetch the invoices. The date should be specified in MM-DD-YYYY format. ,
Required: True ,
}
string ,
periodEndDate:
{
Description: The end date to fetch the invoices. The date should be specified in MM-DD-YYYY format. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of invoices. ,
Required: False ,
}
[
{
properties:
{
Description: An invoice. ,
Required: False ,
}
{
dueDate:
{
Description: The due date for the invoice. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceDate:
{
Description: The date when the invoice was generated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the invoice. ,
Enum:
{
Due: No description available. ,
OverDue: No description available. ,
Paid: No description available. ,
Void: No description available. ,
}
,
Required: False ,
}
enum ,
amountDue:
{
Description: The amount due as of now. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
azurePrepaymentApplied:
{
Description: The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billedAmount:
{
Description: The total charges for the invoice billing period. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
creditAmount:
{
Description: 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. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
freeAzureCreditApplied:
{
Description: The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
subTotal:
{
Description: The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
taxAmount:
{
Description: The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
totalAmount:
{
Description: The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
invoicePeriodStartDate:
{
Description: The start date of the billing period for which the invoice is generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end date of the billing period for which the invoice is generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceType:
{
Description: Invoice type. ,
Enum:
{
AzureService: No description available. ,
AzureMarketplace: No description available. ,
AzureSupport: No description available. ,
}
,
Required: False ,
}
enum ,
isMonthlyInvoice:
{
Description: Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
boolean ,
billingProfileId:
{
Description: The ID of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
purchaseOrderNumber:
{
Description: An optional purchase order number for the invoice. ,
Required: False ,
}
string ,
documents:
{
Description: List of documents available to download such as invoice and tax receipt. ,
Required: False ,
}
[
{
kind:
{
Description: The type of the document. ,
Enum:
{
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: Document URL. ,
Required: False ,
}
string ,
documentNumbers:
{
Description: Document numbers for an Enterprise Agreement invoice. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
payments:
{
Description: List of payments. ,
Required: False ,
}
[
{
paymentType:
{
Description: The type of payment. ,
Required: False ,
}
string ,
amount:
{
Description: The paid amount. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
date:
{
Description: The date when the payment was made. ,
Format: date-time ,
Required: False ,
}
string ,
paymentMethodFamily:
{
Description: The family of payment method. ,
Enum:
{
Credits: No description available. ,
CheckWire: No description available. ,
CreditCard: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
}
,
]
,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
Required: False ,
}
string ,
rebillDetails:
{
Description: Rebill details of an Enterprise Agreement invoice. ,
Required: False ,
}
{
rebillDocumentType:
{
Description: The type of the document generated when an Enterprise Agreement invoice is rebilled. ,
Enum:
{
Credit: No description available. ,
Rebill: No description available. ,
Original: No description available. ,
}
,
Required: False ,
}
enum ,
rebilledInvoiceId:
{
Description: The ID of the invoice generated when an Enterprise Agreement invoice is rebilled. ,
Required: False ,
}
string ,
latestInvoiceId:
{
Description: The ID of the latest invoice generated when an Enterprise Agreement invoice is rebilled. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Invoices_DownloadMultipleBillingProfileInvoices (new)
Description :  Gets a URL to download multiple invoice documents (invoice pdf, tax receipts, credit notes) as a zip file.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/downloadDocuments
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
downloadUrls:
{
Description: An array of download urls for individual documents. The download url paths in the request body should match the path of the original request. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: GET this URL to retrieve the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
string ,
}

⚐ Response (200)

{
expiryTime:
{
Description: The time in UTC when the download URL will expire. ,
Format: date-time ,
Required: False ,
}
string ,
url:
{
Description: The URL to the PDF file. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Invoices_Get (new)
Description :  Gets an invoice by ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices/{invoiceName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceName:
{
Description: The ID that uniquely identifies an invoice. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: An invoice. ,
Required: False ,
}
{
dueDate:
{
Description: The due date for the invoice. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceDate:
{
Description: The date when the invoice was generated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the invoice. ,
Enum:
{
Due: No description available. ,
OverDue: No description available. ,
Paid: No description available. ,
Void: No description available. ,
}
,
Required: False ,
}
enum ,
amountDue:
{
Description: The amount due as of now. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
azurePrepaymentApplied:
{
Description: The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billedAmount:
{
Description: The total charges for the invoice billing period. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
creditAmount:
{
Description: 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. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
freeAzureCreditApplied:
{
Description: The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
subTotal:
{
Description: The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
taxAmount:
{
Description: The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
totalAmount:
{
Description: The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
invoicePeriodStartDate:
{
Description: The start date of the billing period for which the invoice is generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end date of the billing period for which the invoice is generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceType:
{
Description: Invoice type. ,
Enum:
{
AzureService: No description available. ,
AzureMarketplace: No description available. ,
AzureSupport: No description available. ,
}
,
Required: False ,
}
enum ,
isMonthlyInvoice:
{
Description: Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
boolean ,
billingProfileId:
{
Description: The ID of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
purchaseOrderNumber:
{
Description: An optional purchase order number for the invoice. ,
Required: False ,
}
string ,
documents:
{
Description: List of documents available to download such as invoice and tax receipt. ,
Required: False ,
}
[
{
kind:
{
Description: The type of the document. ,
Enum:
{
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: Document URL. ,
Required: False ,
}
string ,
documentNumbers:
{
Description: Document numbers for an Enterprise Agreement invoice. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
payments:
{
Description: List of payments. ,
Required: False ,
}
[
{
paymentType:
{
Description: The type of payment. ,
Required: False ,
}
string ,
amount:
{
Description: The paid amount. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
date:
{
Description: The date when the payment was made. ,
Format: date-time ,
Required: False ,
}
string ,
paymentMethodFamily:
{
Description: The family of payment method. ,
Enum:
{
Credits: No description available. ,
CheckWire: No description available. ,
CreditCard: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
}
,
]
,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
Required: False ,
}
string ,
rebillDetails:
{
Description: Rebill details of an Enterprise Agreement invoice. ,
Required: False ,
}
{
rebillDocumentType:
{
Description: The type of the document generated when an Enterprise Agreement invoice is rebilled. ,
Enum:
{
Credit: No description available. ,
Rebill: No description available. ,
Original: No description available. ,
}
,
Required: False ,
}
enum ,
rebilledInvoiceId:
{
Description: The ID of the invoice generated when an Enterprise Agreement invoice is rebilled. ,
Required: False ,
}
string ,
latestInvoiceId:
{
Description: The ID of the latest invoice generated when an Enterprise Agreement invoice is rebilled. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingSubscriptions_ListByBillingAccount (new)
Description :  Lists the subscriptions for a billing account. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing subscriptions. ,
Required: False ,
}
[
{
properties:
{
Description: The billing properties of a subscription. ,
Required: False ,
}
{
displayName:
{
Description: The name of the subscription. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription. ,
Format: uuid ,
Required: False ,
}
string ,
subscriptionBillingStatus:
{
Description: The current billing status of the subscription. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
Abandoned: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
lastMonthCharges:
{
Description: The last month charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billingProfileId:
{
Description: The ID of the billing profile to which the subscription is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the subscription is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the subscription is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the subscription is billed. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this subscription. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The sku ID of the Azure plan for the subscription. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the Azure plan for the subscription. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Invoices_ListByBillingSubscription (new)
Description :  Lists the invoices for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}/invoices
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: The ID that uniquely identifies a subscription. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: Invoice period start date. ,
Required: True ,
}
string ,
periodEndDate:
{
Description: Invoice period end date. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of invoices. ,
Required: False ,
}
[
{
properties:
{
Description: An invoice. ,
Required: False ,
}
{
dueDate:
{
Description: The due date for the invoice. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceDate:
{
Description: The date when the invoice was generated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the invoice. ,
Enum:
{
Due: No description available. ,
OverDue: No description available. ,
Paid: No description available. ,
Void: No description available. ,
}
,
Required: False ,
}
enum ,
amountDue:
{
Description: The amount due as of now. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
azurePrepaymentApplied:
{
Description: The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billedAmount:
{
Description: The total charges for the invoice billing period. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
creditAmount:
{
Description: 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. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
freeAzureCreditApplied:
{
Description: The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
subTotal:
{
Description: The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
taxAmount:
{
Description: The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
totalAmount:
{
Description: The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
invoicePeriodStartDate:
{
Description: The start date of the billing period for which the invoice is generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end date of the billing period for which the invoice is generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceType:
{
Description: Invoice type. ,
Enum:
{
AzureService: No description available. ,
AzureMarketplace: No description available. ,
AzureSupport: No description available. ,
}
,
Required: False ,
}
enum ,
isMonthlyInvoice:
{
Description: Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
boolean ,
billingProfileId:
{
Description: The ID of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
purchaseOrderNumber:
{
Description: An optional purchase order number for the invoice. ,
Required: False ,
}
string ,
documents:
{
Description: List of documents available to download such as invoice and tax receipt. ,
Required: False ,
}
[
{
kind:
{
Description: The type of the document. ,
Enum:
{
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: Document URL. ,
Required: False ,
}
string ,
documentNumbers:
{
Description: Document numbers for an Enterprise Agreement invoice. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
payments:
{
Description: List of payments. ,
Required: False ,
}
[
{
paymentType:
{
Description: The type of payment. ,
Required: False ,
}
string ,
amount:
{
Description: The paid amount. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
date:
{
Description: The date when the payment was made. ,
Format: date-time ,
Required: False ,
}
string ,
paymentMethodFamily:
{
Description: The family of payment method. ,
Enum:
{
Credits: No description available. ,
CheckWire: No description available. ,
CreditCard: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
}
,
]
,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
Required: False ,
}
string ,
rebillDetails:
{
Description: Rebill details of an Enterprise Agreement invoice. ,
Required: False ,
}
{
rebillDocumentType:
{
Description: The type of the document generated when an Enterprise Agreement invoice is rebilled. ,
Enum:
{
Credit: No description available. ,
Rebill: No description available. ,
Original: No description available. ,
}
,
Required: False ,
}
enum ,
rebilledInvoiceId:
{
Description: The ID of the invoice generated when an Enterprise Agreement invoice is rebilled. ,
Required: False ,
}
string ,
latestInvoiceId:
{
Description: The ID of the latest invoice generated when an Enterprise Agreement invoice is rebilled. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Invoices_GetById (new)
Description :  Gets an invoice by ID.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}/invoices/{invoiceName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: The ID that uniquely identifies a subscription. ,
Required: True ,
}
string ,
invoiceName:
{
Description: The ID that uniquely identifies an invoice. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: An invoice. ,
Required: False ,
}
{
dueDate:
{
Description: The due date for the invoice. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceDate:
{
Description: The date when the invoice was generated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the invoice. ,
Enum:
{
Due: No description available. ,
OverDue: No description available. ,
Paid: No description available. ,
Void: No description available. ,
}
,
Required: False ,
}
enum ,
amountDue:
{
Description: The amount due as of now. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
azurePrepaymentApplied:
{
Description: The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billedAmount:
{
Description: The total charges for the invoice billing period. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
creditAmount:
{
Description: 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. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
freeAzureCreditApplied:
{
Description: The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
subTotal:
{
Description: The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
taxAmount:
{
Description: The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
totalAmount:
{
Description: The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
invoicePeriodStartDate:
{
Description: The start date of the billing period for which the invoice is generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end date of the billing period for which the invoice is generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceType:
{
Description: Invoice type. ,
Enum:
{
AzureService: No description available. ,
AzureMarketplace: No description available. ,
AzureSupport: No description available. ,
}
,
Required: False ,
}
enum ,
isMonthlyInvoice:
{
Description: Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
boolean ,
billingProfileId:
{
Description: The ID of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
purchaseOrderNumber:
{
Description: An optional purchase order number for the invoice. ,
Required: False ,
}
string ,
documents:
{
Description: List of documents available to download such as invoice and tax receipt. ,
Required: False ,
}
[
{
kind:
{
Description: The type of the document. ,
Enum:
{
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: Document URL. ,
Required: False ,
}
string ,
documentNumbers:
{
Description: Document numbers for an Enterprise Agreement invoice. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
payments:
{
Description: List of payments. ,
Required: False ,
}
[
{
paymentType:
{
Description: The type of payment. ,
Required: False ,
}
string ,
amount:
{
Description: The paid amount. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
date:
{
Description: The date when the payment was made. ,
Format: date-time ,
Required: False ,
}
string ,
paymentMethodFamily:
{
Description: The family of payment method. ,
Enum:
{
Credits: No description available. ,
CheckWire: No description available. ,
CreditCard: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
}
,
]
,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
Required: False ,
}
string ,
rebillDetails:
{
Description: Rebill details of an Enterprise Agreement invoice. ,
Required: False ,
}
{
rebillDocumentType:
{
Description: The type of the document generated when an Enterprise Agreement invoice is rebilled. ,
Enum:
{
Credit: No description available. ,
Rebill: No description available. ,
Original: No description available. ,
}
,
Required: False ,
}
enum ,
rebilledInvoiceId:
{
Description: The ID of the invoice generated when an Enterprise Agreement invoice is rebilled. ,
Required: False ,
}
string ,
latestInvoiceId:
{
Description: The ID of the latest invoice generated when an Enterprise Agreement invoice is rebilled. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingSubscriptions_ListByBillingProfile (new)
Description :  Lists the subscriptions that are billed to a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingSubscriptions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing subscriptions. ,
Required: False ,
}
[
{
properties:
{
Description: The billing properties of a subscription. ,
Required: False ,
}
{
displayName:
{
Description: The name of the subscription. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription. ,
Format: uuid ,
Required: False ,
}
string ,
subscriptionBillingStatus:
{
Description: The current billing status of the subscription. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
Abandoned: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
lastMonthCharges:
{
Description: The last month charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billingProfileId:
{
Description: The ID of the billing profile to which the subscription is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the subscription is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the subscription is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the subscription is billed. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this subscription. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The sku ID of the Azure plan for the subscription. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the Azure plan for the subscription. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingSubscriptions_ListByInvoiceSection (new)
Description :  Lists the subscriptions that are billed to an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingSubscriptions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing subscriptions. ,
Required: False ,
}
[
{
properties:
{
Description: The billing properties of a subscription. ,
Required: False ,
}
{
displayName:
{
Description: The name of the subscription. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription. ,
Format: uuid ,
Required: False ,
}
string ,
subscriptionBillingStatus:
{
Description: The current billing status of the subscription. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
Abandoned: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
lastMonthCharges:
{
Description: The last month charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billingProfileId:
{
Description: The ID of the billing profile to which the subscription is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the subscription is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the subscription is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the subscription is billed. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this subscription. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The sku ID of the Azure plan for the subscription. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the Azure plan for the subscription. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingSubscriptions_Get (new)
Description :  Gets a subscription by its ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingSubscriptions/{billingSubscriptionName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: The ID that uniquely identifies a subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The billing properties of a subscription. ,
Required: False ,
}
{
displayName:
{
Description: The name of the subscription. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription. ,
Format: uuid ,
Required: False ,
}
string ,
subscriptionBillingStatus:
{
Description: The current billing status of the subscription. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
Abandoned: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
lastMonthCharges:
{
Description: The last month charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billingProfileId:
{
Description: The ID of the billing profile to which the subscription is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the subscription is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the subscription is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the subscription is billed. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this subscription. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The sku ID of the Azure plan for the subscription. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the Azure plan for the subscription. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingSubscriptions_Transfer (new)
Description :  Moves a subscription's charges to a new invoice section. The new invoice section must belong to the same billing profile as the existing invoice section. This operation is supported only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingSubscriptions/{billingSubscriptionName}/transfer
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: The ID that uniquely identifies a subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the transfer product operation. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: False ,
}
string ,
destinationBillingProfileId:
{
Description: The destination billing profile id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the transfer billing subscription operation result. ,
Required: False ,
}
{
billingSubscriptionName:
{
Description: The destination billing subscription id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result. ,
}
string ,
retry-after:
{
Description: Recommended time to wait before making another request to check the status of the operation. The time is specified in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingSubscriptions_ValidateTransfer (new)
Description :  Validates if a subscription's charges can be moved to a new invoice section. This operation is supported only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingSubscriptions/{billingSubscriptionName}/validateTransferEligibility
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: The ID that uniquely identifies a subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the validate transfer eligibility operation. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: False ,
}
string ,
destinationBillingProfileId:
{
Description: The destination billing profile id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
isTransferEligible:
{
Description: Specifies whether the subscription is eligible to be transferred. ,
Required: False ,
}
boolean ,
errorDetails:
{
Description: Validation error details. ,
Required: False ,
}
{
code:
{
Description: Error code for the product transfer validation. ,
Enum:
{
BillingAccountInactive: No description available. ,
CrossBillingAccountNotAllowed: No description available. ,
DestinationBillingProfileInactive: No description available. ,
DestinationBillingProfileNotFound: No description available. ,
DestinationBillingProfilePastDue: No description available. ,
DestinationInvoiceSectionInactive: No description available. ,
DestinationInvoiceSectionNotFound: No description available. ,
InsufficientPermissionOnDestination: No description available. ,
InsufficientPermissionOnSource: No description available. ,
InvalidDestination: No description available. ,
InvalidSource: No description available. ,
MarketplaceNotEnabledOnDestination: No description available. ,
NotAvailableForDestinationMarket: No description available. ,
ProductInactive: No description available. ,
ProductNotFound: No description available. ,
ProductTypeNotSupported: No description available. ,
SourceBillingProfilePastDue: No description available. ,
SourceInvoiceSectionInactive: No description available. ,
SubscriptionNotActive: No description available. ,
SubscriptionTypeNotSupported: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: Detailed error message explaining the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Products_ListByBillingAccount (new)
Description :  Lists the products for a billing account. These don't include products billed based on usage. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter by product type. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value are separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of products. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a product. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date when the product was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the type of product. ,
Required: False ,
}
string ,
productType:
{
Description: The description of the type of product. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the product. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
PastDue: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
Disabled: No description available. ,
Cancelled: No description available. ,
AutoRenew: No description available. ,
}
,
Required: False ,
}
enum ,
endDate:
{
Description: The date when the product will be renewed or canceled. ,
Format: date-time ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The frequency at which the product will be billed. ,
Enum:
{
OneTime: No description available. ,
Monthly: No description available. ,
UsageBased: No description available. ,
}
,
Required: False ,
}
enum ,
lastCharge:
{
Description: The last month charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
lastChargeDate:
{
Description: The date of the last charge. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased for the product. ,
Required: False ,
}
number ,
skuId:
{
Description: The sku ID of the product. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the product. ,
Required: False ,
}
string ,
tenantId:
{
Description: The id of the tenant in which the product is used. ,
Required: False ,
}
string ,
availabilityId:
{
Description: The availability of the product. ,
Required: False ,
}
string ,
parentProductId:
{
Description: Parent product Id. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this product. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Products_ListByInvoiceSection (new)
Description :  Lists the products for an invoice section. These don't include products billed based on usage. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/products
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter by product type. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value are separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of products. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a product. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date when the product was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the type of product. ,
Required: False ,
}
string ,
productType:
{
Description: The description of the type of product. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the product. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
PastDue: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
Disabled: No description available. ,
Cancelled: No description available. ,
AutoRenew: No description available. ,
}
,
Required: False ,
}
enum ,
endDate:
{
Description: The date when the product will be renewed or canceled. ,
Format: date-time ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The frequency at which the product will be billed. ,
Enum:
{
OneTime: No description available. ,
Monthly: No description available. ,
UsageBased: No description available. ,
}
,
Required: False ,
}
enum ,
lastCharge:
{
Description: The last month charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
lastChargeDate:
{
Description: The date of the last charge. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased for the product. ,
Required: False ,
}
number ,
skuId:
{
Description: The sku ID of the product. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the product. ,
Required: False ,
}
string ,
tenantId:
{
Description: The id of the tenant in which the product is used. ,
Required: False ,
}
string ,
availabilityId:
{
Description: The availability of the product. ,
Required: False ,
}
string ,
parentProductId:
{
Description: Parent product Id. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this product. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Products_Get (new)
Description :  Gets a product by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/products/{productName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
productName:
{
Description: The ID that uniquely identifies a product. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a product. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date when the product was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the type of product. ,
Required: False ,
}
string ,
productType:
{
Description: The description of the type of product. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the product. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
PastDue: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
Disabled: No description available. ,
Cancelled: No description available. ,
AutoRenew: No description available. ,
}
,
Required: False ,
}
enum ,
endDate:
{
Description: The date when the product will be renewed or canceled. ,
Format: date-time ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The frequency at which the product will be billed. ,
Enum:
{
OneTime: No description available. ,
Monthly: No description available. ,
UsageBased: No description available. ,
}
,
Required: False ,
}
enum ,
lastCharge:
{
Description: The last month charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
lastChargeDate:
{
Description: The date of the last charge. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased for the product. ,
Required: False ,
}
number ,
skuId:
{
Description: The sku ID of the product. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the product. ,
Required: False ,
}
string ,
tenantId:
{
Description: The id of the tenant in which the product is used. ,
Required: False ,
}
string ,
availabilityId:
{
Description: The availability of the product. ,
Required: False ,
}
string ,
parentProductId:
{
Description: Parent product Id. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this product. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Products_Transfer (new)
Description :  Moves a product's charges to a new invoice section. The new invoice section must belong to the same billing profile as the existing invoice section. This operation is supported only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/products/{productName}/transfer
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
productName:
{
Description: The ID that uniquely identifies a product. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the transfer product operation. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: False ,
}
string ,
destinationBillingProfileId:
{
Description: The destination billing profile id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a product. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date when the product was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the type of product. ,
Required: False ,
}
string ,
productType:
{
Description: The description of the type of product. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the product. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
PastDue: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
Disabled: No description available. ,
Cancelled: No description available. ,
AutoRenew: No description available. ,
}
,
Required: False ,
}
enum ,
endDate:
{
Description: The date when the product will be renewed or canceled. ,
Format: date-time ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The frequency at which the product will be billed. ,
Enum:
{
OneTime: No description available. ,
Monthly: No description available. ,
UsageBased: No description available. ,
}
,
Required: False ,
}
enum ,
lastCharge:
{
Description: The last month charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
lastChargeDate:
{
Description: The date of the last charge. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased for the product. ,
Required: False ,
}
number ,
skuId:
{
Description: The sku ID of the product. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the product. ,
Required: False ,
}
string ,
tenantId:
{
Description: The id of the tenant in which the product is used. ,
Required: False ,
}
string ,
availabilityId:
{
Description: The availability of the product. ,
Required: False ,
}
string ,
parentProductId:
{
Description: Parent product Id. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this product. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result ,
}
string ,
retry-after:
{
Description: Recommended time to wait before making another request to check the status of the operation. The time is specified in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Products_ValidateTransfer (new)
Description :  Validates if a product's charges can be moved to a new invoice section. This operation is supported only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/products/{productName}/validateTransferEligibility
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
productName:
{
Description: The ID that uniquely identifies a product. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the validate transfer eligibility operation. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: False ,
}
string ,
destinationBillingProfileId:
{
Description: The destination billing profile id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
isTransferEligible:
{
Description: Specifies whether the transfer is eligible or not. ,
Required: False ,
}
boolean ,
errorDetails:
{
Description: Validation error details. ,
Required: False ,
}
{
code:
{
Description: Error code for the product transfer validation. ,
Enum:
{
InvalidSource: No description available. ,
ProductNotActive: No description available. ,
InsufficientPermissionOnSource: No description available. ,
InsufficientPermissionOnDestination: No description available. ,
DestinationBillingProfilePastDue: No description available. ,
ProductTypeNotSupported: No description available. ,
CrossBillingAccountNotAllowed: No description available. ,
NotAvailableForDestinationMarket: No description available. ,
OneTimePurchaseProductTransferNotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: Detailed error message explaining the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Transactions_ListByBillingAccount (new)
Description :  Lists the billed and unbilled transactions by billing account name for given start and end date. Transactions include purchases, refunds and Azure usage charges. Unbilled transactions are listed under pending invoice ID and do not include tax. Tax is added to the amount once an invoice is generated.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/transactions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Required: True ,
}
string ,
periodEndDate:
{
Description: The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter by transaction type. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value are separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of transactions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a transaction. ,
Required: False ,
}
{
kind:
{
Description: The kind of transaction. Options are all or reservation. ,
Enum:
{
all: No description available. ,
reservation: No description available. ,
}
,
Required: False ,
}
enum ,
date:
{
Description: The date of transaction. ,
Format: date-time ,
Required: False ,
}
string ,
invoice:
{
Description: Invoice on which the transaction was billed or 'pending' if the transaction is not billed. ,
Required: False ,
}
string ,
orderId:
{
Description: The order ID of the reservation. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
orderName:
{
Description: The name of the reservation order. The field is only applicable for transactions of kind reservation. ,
Required: False ,
}
string ,
productFamily:
{
Description: The family of the product for which the transaction took place. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product type for which the transaction took place. ,
Required: False ,
}
string ,
productType:
{
Description: The type of the product for which the transaction took place. ,
Required: False ,
}
string ,
productDescription:
{
Description: The description of the product for which the transaction took place. ,
Required: False ,
}
string ,
transactionType:
{
Description: The type of transaction. ,
Enum:
{
Purchase: No description available. ,
Usage Charge: No description available. ,
}
,
Required: False ,
}
enum ,
transactionAmount:
{
Description: The charge associated with the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
quantity:
{
Description: The quantity purchased in the transaction. ,
Format: int32 ,
Required: False ,
}
integer ,
invoiceSectionId:
{
Description: The ID of the invoice section which will be billed for the transaction. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section which will be billed for the transaction. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile which will be billed for the transaction. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile which will be billed for the transaction. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The name of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
azureCreditApplied:
{
Description: The amount of any Azure credits automatically applied to this transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billingCurrency:
{
Description: The ISO 4217 code for the currency in which this transaction is billed. ,
Required: False ,
}
string ,
discount:
{
Description: The percentage discount, if any, applied to this transaction. ,
Required: False ,
}
number ,
effectivePrice:
{
Description: The price of the product after applying any discounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
exchangeRate:
{
Description: The exchange rate used to convert charged amount to billing currency, if applicable. ,
Required: False ,
}
number ,
marketPrice:
{
Description: The retail price of the product. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
pricingCurrency:
{
Description: The ISO 4217 code for the currency in which the product is priced. ,
Required: False ,
}
string ,
servicePeriodStartDate:
{
Description: The date of the purchase of the product, or the start date of the month in which usage started. ,
Format: date-time ,
Required: False ,
}
string ,
servicePeriodEndDate:
{
Description: The end date of the product term, or the end date of the month in which usage ended. ,
Format: date-time ,
Required: False ,
}
string ,
subTotal:
{
Description: The pre-tax charged amount for the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
tax:
{
Description: The tax amount applied to the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
unitOfMeasure:
{
Description: The unit of measure used to bill for the product. For example, compute services are billed per hour. ,
Required: False ,
}
string ,
units:
{
Description: The number of units used for a given product. ,
Required: False ,
}
number ,
unitType:
{
Description: The description for the unit of measure for a given product. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Transactions_ListByBillingProfile (new)
Description :  Lists the billed and unbilled transactions by billing profile name for given start date and end date. Transactions include purchases, refunds and Azure usage charges. Unbilled transactions are listed under pending invoice Id and do not include tax. Tax is added to the amount once an invoice is generated.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/transactions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Required: True ,
}
string ,
periodEndDate:
{
Description: The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter by transaction type. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value are separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of transactions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a transaction. ,
Required: False ,
}
{
kind:
{
Description: The kind of transaction. Options are all or reservation. ,
Enum:
{
all: No description available. ,
reservation: No description available. ,
}
,
Required: False ,
}
enum ,
date:
{
Description: The date of transaction. ,
Format: date-time ,
Required: False ,
}
string ,
invoice:
{
Description: Invoice on which the transaction was billed or 'pending' if the transaction is not billed. ,
Required: False ,
}
string ,
orderId:
{
Description: The order ID of the reservation. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
orderName:
{
Description: The name of the reservation order. The field is only applicable for transactions of kind reservation. ,
Required: False ,
}
string ,
productFamily:
{
Description: The family of the product for which the transaction took place. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product type for which the transaction took place. ,
Required: False ,
}
string ,
productType:
{
Description: The type of the product for which the transaction took place. ,
Required: False ,
}
string ,
productDescription:
{
Description: The description of the product for which the transaction took place. ,
Required: False ,
}
string ,
transactionType:
{
Description: The type of transaction. ,
Enum:
{
Purchase: No description available. ,
Usage Charge: No description available. ,
}
,
Required: False ,
}
enum ,
transactionAmount:
{
Description: The charge associated with the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
quantity:
{
Description: The quantity purchased in the transaction. ,
Format: int32 ,
Required: False ,
}
integer ,
invoiceSectionId:
{
Description: The ID of the invoice section which will be billed for the transaction. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section which will be billed for the transaction. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile which will be billed for the transaction. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile which will be billed for the transaction. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The name of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
azureCreditApplied:
{
Description: The amount of any Azure credits automatically applied to this transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billingCurrency:
{
Description: The ISO 4217 code for the currency in which this transaction is billed. ,
Required: False ,
}
string ,
discount:
{
Description: The percentage discount, if any, applied to this transaction. ,
Required: False ,
}
number ,
effectivePrice:
{
Description: The price of the product after applying any discounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
exchangeRate:
{
Description: The exchange rate used to convert charged amount to billing currency, if applicable. ,
Required: False ,
}
number ,
marketPrice:
{
Description: The retail price of the product. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
pricingCurrency:
{
Description: The ISO 4217 code for the currency in which the product is priced. ,
Required: False ,
}
string ,
servicePeriodStartDate:
{
Description: The date of the purchase of the product, or the start date of the month in which usage started. ,
Format: date-time ,
Required: False ,
}
string ,
servicePeriodEndDate:
{
Description: The end date of the product term, or the end date of the month in which usage ended. ,
Format: date-time ,
Required: False ,
}
string ,
subTotal:
{
Description: The pre-tax charged amount for the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
tax:
{
Description: The tax amount applied to the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
unitOfMeasure:
{
Description: The unit of measure used to bill for the product. For example, compute services are billed per hour. ,
Required: False ,
}
string ,
units:
{
Description: The number of units used for a given product. ,
Required: False ,
}
number ,
unitType:
{
Description: The description for the unit of measure for a given product. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Transactions_ListByInvoiceSection (new)
Description :  Lists the billed and unbilled transactions by invoice section name for given start date and end date. Transactions include purchases, refunds and Azure usage charges. Unbilled transactions are listed under pending invoice Id and do not include tax. Tax is added to the amount once an invoice is generated.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/transactions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Required: True ,
}
string ,
periodEndDate:
{
Description: The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter by transaction type. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value are separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of transactions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a transaction. ,
Required: False ,
}
{
kind:
{
Description: The kind of transaction. Options are all or reservation. ,
Enum:
{
all: No description available. ,
reservation: No description available. ,
}
,
Required: False ,
}
enum ,
date:
{
Description: The date of transaction. ,
Format: date-time ,
Required: False ,
}
string ,
invoice:
{
Description: Invoice on which the transaction was billed or 'pending' if the transaction is not billed. ,
Required: False ,
}
string ,
orderId:
{
Description: The order ID of the reservation. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
orderName:
{
Description: The name of the reservation order. The field is only applicable for transactions of kind reservation. ,
Required: False ,
}
string ,
productFamily:
{
Description: The family of the product for which the transaction took place. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product type for which the transaction took place. ,
Required: False ,
}
string ,
productType:
{
Description: The type of the product for which the transaction took place. ,
Required: False ,
}
string ,
productDescription:
{
Description: The description of the product for which the transaction took place. ,
Required: False ,
}
string ,
transactionType:
{
Description: The type of transaction. ,
Enum:
{
Purchase: No description available. ,
Usage Charge: No description available. ,
}
,
Required: False ,
}
enum ,
transactionAmount:
{
Description: The charge associated with the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
quantity:
{
Description: The quantity purchased in the transaction. ,
Format: int32 ,
Required: False ,
}
integer ,
invoiceSectionId:
{
Description: The ID of the invoice section which will be billed for the transaction. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section which will be billed for the transaction. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile which will be billed for the transaction. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile which will be billed for the transaction. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The name of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
azureCreditApplied:
{
Description: The amount of any Azure credits automatically applied to this transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billingCurrency:
{
Description: The ISO 4217 code for the currency in which this transaction is billed. ,
Required: False ,
}
string ,
discount:
{
Description: The percentage discount, if any, applied to this transaction. ,
Required: False ,
}
number ,
effectivePrice:
{
Description: The price of the product after applying any discounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
exchangeRate:
{
Description: The exchange rate used to convert charged amount to billing currency, if applicable. ,
Required: False ,
}
number ,
marketPrice:
{
Description: The retail price of the product. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
pricingCurrency:
{
Description: The ISO 4217 code for the currency in which the product is priced. ,
Required: False ,
}
string ,
servicePeriodStartDate:
{
Description: The date of the purchase of the product, or the start date of the month in which usage started. ,
Format: date-time ,
Required: False ,
}
string ,
servicePeriodEndDate:
{
Description: The end date of the product term, or the end date of the month in which usage ended. ,
Format: date-time ,
Required: False ,
}
string ,
subTotal:
{
Description: The pre-tax charged amount for the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
tax:
{
Description: The tax amount applied to the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
unitOfMeasure:
{
Description: The unit of measure used to bill for the product. For example, compute services are billed per hour. ,
Required: False ,
}
string ,
units:
{
Description: The number of units used for a given product. ,
Required: False ,
}
number ,
unitType:
{
Description: The description for the unit of measure for a given product. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Transactions_ListByInvoice (new)
Description :  Lists the transactions for an invoice. Transactions include purchases, refunds and Azure usage charges.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices/{invoiceName}/transactions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceName:
{
Description: The ID that uniquely identifies an invoice. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of transactions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a transaction. ,
Required: False ,
}
{
kind:
{
Description: The kind of transaction. Options are all or reservation. ,
Enum:
{
all: No description available. ,
reservation: No description available. ,
}
,
Required: False ,
}
enum ,
date:
{
Description: The date of transaction. ,
Format: date-time ,
Required: False ,
}
string ,
invoice:
{
Description: Invoice on which the transaction was billed or 'pending' if the transaction is not billed. ,
Required: False ,
}
string ,
orderId:
{
Description: The order ID of the reservation. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
orderName:
{
Description: The name of the reservation order. The field is only applicable for transactions of kind reservation. ,
Required: False ,
}
string ,
productFamily:
{
Description: The family of the product for which the transaction took place. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product type for which the transaction took place. ,
Required: False ,
}
string ,
productType:
{
Description: The type of the product for which the transaction took place. ,
Required: False ,
}
string ,
productDescription:
{
Description: The description of the product for which the transaction took place. ,
Required: False ,
}
string ,
transactionType:
{
Description: The type of transaction. ,
Enum:
{
Purchase: No description available. ,
Usage Charge: No description available. ,
}
,
Required: False ,
}
enum ,
transactionAmount:
{
Description: The charge associated with the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
quantity:
{
Description: The quantity purchased in the transaction. ,
Format: int32 ,
Required: False ,
}
integer ,
invoiceSectionId:
{
Description: The ID of the invoice section which will be billed for the transaction. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section which will be billed for the transaction. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile which will be billed for the transaction. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile which will be billed for the transaction. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The name of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
azureCreditApplied:
{
Description: The amount of any Azure credits automatically applied to this transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billingCurrency:
{
Description: The ISO 4217 code for the currency in which this transaction is billed. ,
Required: False ,
}
string ,
discount:
{
Description: The percentage discount, if any, applied to this transaction. ,
Required: False ,
}
number ,
effectivePrice:
{
Description: The price of the product after applying any discounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
exchangeRate:
{
Description: The exchange rate used to convert charged amount to billing currency, if applicable. ,
Required: False ,
}
number ,
marketPrice:
{
Description: The retail price of the product. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
pricingCurrency:
{
Description: The ISO 4217 code for the currency in which the product is priced. ,
Required: False ,
}
string ,
servicePeriodStartDate:
{
Description: The date of the purchase of the product, or the start date of the month in which usage started. ,
Format: date-time ,
Required: False ,
}
string ,
servicePeriodEndDate:
{
Description: The end date of the product term, or the end date of the month in which usage ended. ,
Format: date-time ,
Required: False ,
}
string ,
subTotal:
{
Description: The pre-tax charged amount for the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
tax:
{
Description: The tax amount applied to the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
unitOfMeasure:
{
Description: The unit of measure used to bill for the product. For example, compute services are billed per hour. ,
Required: False ,
}
string ,
units:
{
Description: The number of units used for a given product. ,
Required: False ,
}
number ,
unitType:
{
Description: The description for the unit of measure for a given product. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Transactions_Get (new)
Description :  Gets a transaction by ID. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/transactions/{transactionName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
transactionName:
{
Description: The ID that uniquely identifies a transaction. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Required: True ,
}
string ,
periodEndDate:
{
Description: The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a transaction. ,
Required: False ,
}
{
kind:
{
Description: The kind of transaction. Options are all or reservation. ,
Enum:
{
all: No description available. ,
reservation: No description available. ,
}
,
Required: False ,
}
enum ,
date:
{
Description: The date of transaction. ,
Format: date-time ,
Required: False ,
}
string ,
invoice:
{
Description: Invoice on which the transaction was billed or 'pending' if the transaction is not billed. ,
Required: False ,
}
string ,
orderId:
{
Description: The order ID of the reservation. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
orderName:
{
Description: The name of the reservation order. The field is only applicable for transactions of kind reservation. ,
Required: False ,
}
string ,
productFamily:
{
Description: The family of the product for which the transaction took place. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product type for which the transaction took place. ,
Required: False ,
}
string ,
productType:
{
Description: The type of the product for which the transaction took place. ,
Required: False ,
}
string ,
productDescription:
{
Description: The description of the product for which the transaction took place. ,
Required: False ,
}
string ,
transactionType:
{
Description: The type of transaction. ,
Enum:
{
Purchase: No description available. ,
Usage Charge: No description available. ,
}
,
Required: False ,
}
enum ,
transactionAmount:
{
Description: The charge associated with the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
quantity:
{
Description: The quantity purchased in the transaction. ,
Format: int32 ,
Required: False ,
}
integer ,
invoiceSectionId:
{
Description: The ID of the invoice section which will be billed for the transaction. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section which will be billed for the transaction. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile which will be billed for the transaction. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile which will be billed for the transaction. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The name of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
azureCreditApplied:
{
Description: The amount of any Azure credits automatically applied to this transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billingCurrency:
{
Description: The ISO 4217 code for the currency in which this transaction is billed. ,
Required: False ,
}
string ,
discount:
{
Description: The percentage discount, if any, applied to this transaction. ,
Required: False ,
}
number ,
effectivePrice:
{
Description: The price of the product after applying any discounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
exchangeRate:
{
Description: The exchange rate used to convert charged amount to billing currency, if applicable. ,
Required: False ,
}
number ,
marketPrice:
{
Description: The retail price of the product. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
pricingCurrency:
{
Description: The ISO 4217 code for the currency in which the product is priced. ,
Required: False ,
}
string ,
servicePeriodStartDate:
{
Description: The date of the purchase of the product, or the start date of the month in which usage started. ,
Format: date-time ,
Required: False ,
}
string ,
servicePeriodEndDate:
{
Description: The end date of the product term, or the end date of the month in which usage ended. ,
Format: date-time ,
Required: False ,
}
string ,
subTotal:
{
Description: The pre-tax charged amount for the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
tax:
{
Description: The tax amount applied to the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
unitOfMeasure:
{
Description: The unit of measure used to bill for the product. For example, compute services are billed per hour. ,
Required: False ,
}
string ,
units:
{
Description: The number of units used for a given product. ,
Required: False ,
}
number ,
unitType:
{
Description: The description for the unit of measure for a given product. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Policies_GetByBillingProfile (new)
Description :  Lists the policies for a billing profile. This operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/policies/default
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a policy. ,
Required: False ,
}
{
marketplacePurchases:
{
Description: The policy that controls whether Azure marketplace purchases are allowed for a billing profile. ,
Enum:
{
AllAllowed: No description available. ,
OnlyFreeAllowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
reservationPurchases:
{
Description: The policy that controls whether Azure reservation purchases are allowed for a billing profile. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
viewCharges:
{
Description: The policy that controls whether users with Azure RBAC access to a subscription can view its charges. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Policies_Update (new)
Description :  Updates the policies for a billing profile. This operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/policies/default
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the update policies operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of a policy. ,
Required: False ,
}
{
marketplacePurchases:
{
Description: The policy that controls whether Azure marketplace purchases are allowed for a billing profile. ,
Enum:
{
AllAllowed: No description available. ,
OnlyFreeAllowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
reservationPurchases:
{
Description: The policy that controls whether Azure reservation purchases are allowed for a billing profile. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
viewCharges:
{
Description: The policy that controls whether users with Azure RBAC access to a subscription can view its charges. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a policy. ,
Required: False ,
}
{
marketplacePurchases:
{
Description: The policy that controls whether Azure marketplace purchases are allowed for a billing profile. ,
Enum:
{
AllAllowed: No description available. ,
OnlyFreeAllowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
reservationPurchases:
{
Description: The policy that controls whether Azure reservation purchases are allowed for a billing profile. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
viewCharges:
{
Description: The policy that controls whether users with Azure RBAC access to a subscription can view its charges. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Policies_GetByCustomer (new)
Description :  Lists the policies for a customer. This operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/policies/default
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a customer's policy. ,
Required: False ,
}
{
viewCharges:
{
Description: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Policies_UpdateCustomer (new)
Description :  Updates the policies for a customer. This operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/policies/default
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the update policies operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of a customer's policy. ,
Required: False ,
}
{
viewCharges:
{
Description: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a customer's policy. ,
Required: False ,
}
{
viewCharges:
{
Description: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingProperty_Get (new)
Description :  Get the billing properties for a subscription. This operation is not supported for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingProperty/default
{
subscriptionId:
{
Description: The ID that uniquely identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A billing property. ,
Required: False ,
}
{
billingTenantId:
{
Description: The Azure AD tenant ID of the billing account for the subscription. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The ID of the billing account to which the subscription is billed. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account to which the subscription is billed. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the subscription is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the subscription is billed. ,
Required: False ,
}
string ,
billingProfileStatus:
{
Description: The status of the billing profile. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfileStatusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
PastDue: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfileSpendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
costCenter:
{
Description: The cost center applied to the subscription. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the subscription is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the subscription is billed. ,
Required: False ,
}
string ,
productId:
{
Description: The product ID of the Azure plan. ,
Required: False ,
}
string ,
productName:
{
Description: The product name of the Azure plan. ,
Required: False ,
}
string ,
skuId:
{
Description: The sku ID of the Azure plan for the subscription. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the Azure plan for the subscription. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Products_UpdateAutoRenewByInvoiceSection (new)
Description :  Cancel auto renew for product by product id and invoice section name
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/products/{productName}/updateAutoRenew
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
productName:
{
Description: The ID that uniquely identifies a product. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
body:
{
Description: Request parameters that are provided to the update auto renew operation. ,
Required: True ,
}
{
autoRenew:
{
Description: The flag that determines the auto-renew settings for a product. ,
Enum:
{
true: No description available. ,
false: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Summary of update auto renew operation properties ,
Required: False ,
}
{
endDate:
{
Description: The date at which the product will be canceled. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
InvoiceSections_ElevateToBillingProfile (new)
Description :  Gives the caller permissions on an invoice section based on their billing profile access. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/elevate
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Transfers_Initiate (new)
Description :  Sends a request to a user in another billing account to transfer billing ownership of their subscriptions. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/initiateTransfer
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the initiate transfer operation. ,
Required: True ,
}
{
properties:
{
Description: Request parameters to initiate transfer. ,
Required: False ,
}
{
recipientEmailId:
{
Description: The email ID of the recipient to whom the transfer request is sent. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: The time at which the transfer request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The ID of the billing account to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
resellerName:
{
Description: Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
initiatorCustomerType:
{
Description: The type of customer who sent the transfer request. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product will be billed after the transfer. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The time at which the transfer request was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Transfers_Get (new)
Description :  Gets a transfer request by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/transfers/{transferName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: The time at which the transfer request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The ID of the billing account to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
resellerName:
{
Description: Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
initiatorCustomerType:
{
Description: The type of customer who sent the transfer request. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product will be billed after the transfer. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The time at which the transfer request was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Transfers_Cancel (new)
Description :  Cancels a transfer request. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/transfers/{transferName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: The time at which the transfer request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The ID of the billing account to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
resellerName:
{
Description: Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
initiatorCustomerType:
{
Description: The type of customer who sent the transfer request. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product will be billed after the transfer. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The time at which the transfer request was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Transfers_List (new)
Description :  Lists the transfer requests for an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/transfers
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of transfers initiated by caller. ,
Required: False ,
}
[
{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: The time at which the transfer request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The ID of the billing account to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
resellerName:
{
Description: Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
initiatorCustomerType:
{
Description: The type of customer who sent the transfer request. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product will be billed after the transfer. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The time at which the transfer request was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
PartnerTransfers_Initiate (new)
Description :  Sends a request to a user in a customer's billing account to transfer billing ownership of their subscriptions. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/initiateTransfer
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the initiate transfer operation. ,
Required: True ,
}
{
properties:
{
Description: Request parameters to initiate transfer. ,
Required: False ,
}
{
recipientEmailId:
{
Description: The email ID of the recipient to whom the transfer request is sent. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: The time at which the transfer request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The ID of the billing account to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
resellerName:
{
Description: Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
initiatorCustomerType:
{
Description: The type of customer who sent the transfer request. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product will be billed after the transfer. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The time at which the transfer request was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
PartnerTransfers_Get (new)
Description :  Gets a transfer request by ID. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/transfers/{transferName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: The time at which the transfer request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The ID of the billing account to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
resellerName:
{
Description: Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
initiatorCustomerType:
{
Description: The type of customer who sent the transfer request. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product will be billed after the transfer. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The time at which the transfer request was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
PartnerTransfers_Cancel (new)
Description :  Cancels a transfer request. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/transfers/{transferName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: The time at which the transfer request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The ID of the billing account to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
resellerName:
{
Description: Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
initiatorCustomerType:
{
Description: The type of customer who sent the transfer request. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product will be billed after the transfer. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The time at which the transfer request was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
PartnerTransfers_List (new)
Description :  Lists the transfer requests sent to a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/transfers
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of transfers initiated by caller. ,
Required: False ,
}
[
{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: The time at which the transfer request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The ID of the billing account to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
resellerName:
{
Description: Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
initiatorCustomerType:
{
Description: The type of customer who sent the transfer request. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product will be billed after the transfer. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The time at which the transfer request was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
RecipientTransfers_Accept (new)
Description :  Accepts a transfer request.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/transfers/{transferName}/acceptTransfer
{
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the accept transfer operation. ,
Required: True ,
}
{
properties:
{
Description: Request parameters to accept transfer. ,
Required: False ,
}
{
productDetails:
{
Description: Request parameters to accept transfer. ,
Required: False ,
}
[
{
productType:
{
Description: Type of the product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: The time at which the transfer request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
allowedProductType:
{
Description: Type of subscriptions that can be transferred. ,
Required: False ,
}
[
string ,
]
,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
resellerName:
{
Description: Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
initiatorCustomerType:
{
Description: The type of customer who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The time at which the transfer request was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
RecipientTransfers_Validate (new)
Description :  Validates if a subscription or a reservation can be transferred. Use this operation to validate your subscriptions or reservation before using the accept transfer operation.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/transfers/{transferName}/validateTransfer
{
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the validate transfer operation. ,
Required: True ,
}
{
properties:
{
Description: Request parameters to accept transfer. ,
Required: False ,
}
{
productDetails:
{
Description: Request parameters to accept transfer. ,
Required: False ,
}
[
{
productType:
{
Description: Type of the product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of transfer validation results. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of transfer validation response. ,
Required: False ,
}
{
status:
{
Description: The status of validation ,
Required: False ,
}
string ,
productId:
{
Description: The product id for which this result applies. ,
Required: False ,
}
string ,
results:
{
Description: The array of validation results. ,
Required: False ,
}
[
{
level:
{
Description: Result Level. ,
Required: False ,
}
string ,
code:
{
Description: Result Code. ,
Required: False ,
}
string ,
message:
{
Description: The validation message. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
RecipientTransfers_Decline (new)
Description :  Declines a transfer request.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/transfers/{transferName}/declineTransfer
{
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: The time at which the transfer request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
allowedProductType:
{
Description: Type of subscriptions that can be transferred. ,
Required: False ,
}
[
string ,
]
,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
resellerName:
{
Description: Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
initiatorCustomerType:
{
Description: The type of customer who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The time at which the transfer request was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
RecipientTransfers_Get (new)
Description :  Gets a transfer request by ID. The caller must be the recipient of the transfer request.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/transfers/{transferName}
{
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: The time at which the transfer request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
allowedProductType:
{
Description: Type of subscriptions that can be transferred. ,
Required: False ,
}
[
string ,
]
,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
resellerName:
{
Description: Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
initiatorCustomerType:
{
Description: The type of customer who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The time at which the transfer request was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
RecipientTransfers_List (new)
Description :  Lists the transfer requests received by the caller.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/transfers
{}

⚐ Response (200)

{
value:
{
Description: The list of transfers received by caller. ,
Required: False ,
}
[
{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: The time at which the transfer request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
allowedProductType:
{
Description: Type of subscriptions that can be transferred. ,
Required: False ,
}
[
string ,
]
,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
resellerName:
{
Description: Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
initiatorCustomerType:
{
Description: The type of customer who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The time at which the transfer request was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  Lists the available billing REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/operations
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing operations supported by the Microsoft.Billing resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.Billing. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed such as invoice and billing subscription. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type such as read, write and delete. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingPermissions_ListByBillingAccount (new)
Description :  Lists the billing permissions the caller has on a billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingPermissions
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billingPermissions a caller has on a billing account. ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingPermissions_ListByInvoiceSections (new)
Description :  Lists the billing permissions the caller has on an invoice section.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingPermissions
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billingPermissions a caller has on a billing account. ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingPermissions_ListByBillingProfile (new)
Description :  Lists the billing permissions the caller has on a billing profile.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingPermissions
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billingPermissions a caller has on a billing account. ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingPermissions_ListByDepartment (new)
Description :  Lists the billing permissions the caller has on a department.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingPermissions
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
departmentName:
{
Description: The ID that uniquely identifies a department. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billingPermissions a caller has on a billing account. ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingPermissions_ListByEnrollmentAccount (new)
Description :  Lists the billing permissions the caller has on an enrollment account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingPermissions
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
enrollmentAccountName:
{
Description: The ID that uniquely identifies an enrollment account. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billingPermissions a caller has on a billing account. ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleDefinitions_GetByBillingAccount (new)
Description :  Gets the definition for a role on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/{billingRoleDefinitionName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingRoleDefinitionName:
{
Description: The ID that uniquely identifies a role definition. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the a role definition. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
roleName:
{
Description: The name of the role ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleDefinitions_GetByInvoiceSection (new)
Description :  Gets the definition for a role on an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleDefinitions/{billingRoleDefinitionName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
billingRoleDefinitionName:
{
Description: The ID that uniquely identifies a role definition. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the a role definition. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
roleName:
{
Description: The name of the role ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleDefinitions_GetByBillingProfile (new)
Description :  Gets the definition for a role on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleDefinitions/{billingRoleDefinitionName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
billingRoleDefinitionName:
{
Description: The ID that uniquely identifies a role definition. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the a role definition. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
roleName:
{
Description: The name of the role ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleDefinitions_GetByDepartment (new)
Description :  Gets the definition for a role on a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingRoleDefinitions/{billingRoleDefinitionName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
departmentName:
{
Description: The ID that uniquely identifies a department. ,
Required: True ,
}
string ,
billingRoleDefinitionName:
{
Description: The ID that uniquely identifies a role definition. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the a role definition. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
roleName:
{
Description: The name of the role ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleDefinitions_GetByEnrollmentAccount (new)
Description :  Gets the definition for a role on an enrollment account. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingRoleDefinitions/{billingRoleDefinitionName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
enrollmentAccountName:
{
Description: The ID that uniquely identifies an enrollment account. ,
Required: True ,
}
string ,
billingRoleDefinitionName:
{
Description: The ID that uniquely identifies a role definition. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the a role definition. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
roleName:
{
Description: The name of the role ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleDefinitions_ListByBillingAccount (new)
Description :  Lists the role definitions for a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The role definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the a role definition. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
roleName:
{
Description: The name of the role ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleDefinitions_ListByInvoiceSection (new)
Description :  Lists the role definitions for an invoice section. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleDefinitions
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The role definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the a role definition. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
roleName:
{
Description: The name of the role ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleDefinitions_ListByBillingProfile (new)
Description :  Lists the role definitions for a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleDefinitions
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The role definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the a role definition. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
roleName:
{
Description: The name of the role ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleDefinitions_ListByDepartment (new)
Description :  Lists the role definitions for a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingRoleDefinitions
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
departmentName:
{
Description: The ID that uniquely identifies a department. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The role definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the a role definition. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
roleName:
{
Description: The name of the role ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleDefinitions_ListByEnrollmentAccount (new)
Description :  Lists the role definitions for a enrollmentAccount. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingRoleDefinitions
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
enrollmentAccountName:
{
Description: The ID that uniquely identifies an enrollment account. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The role definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the a role definition. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
roleName:
{
Description: The name of the role ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_GetByBillingAccount (new)
Description :  Gets a role assignment for the caller on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_DeleteByBillingAccount (new)
Description :  Deletes a role assignment for the caller on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
RoleAssignments_Put (new)
Description :  Create or update a billing role assignment.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
parameters:
{
Description: The new or updated billing role assignment. ,
Required: True ,
}
{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_GetByInvoiceSection (new)
Description :  Gets a role assignment for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_DeleteByInvoiceSection (new)
Description :  Deletes a role assignment for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_GetByBillingProfile (new)
Description :  Gets a role assignment for the caller on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_DeleteByBillingProfile (new)
Description :  Deletes a role assignment for the caller on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_GetByDepartment (new)
Description :  Gets a role assignment for the caller on a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
departmentName:
{
Description: The ID that uniquely identifies a department. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_DeleteByDepartment (new)
Description :  Deletes a role assignment for the caller on a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
departmentName:
{
Description: The ID that uniquely identifies a department. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
EnrollmentDepartmentRoleAssignments_Put (new)
Description :  Create or update a billing role assignment.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
departmentName:
{
Description: The ID that uniquely identifies a department. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
parameters:
{
Description: The new or updated billing role assignment. ,
Required: True ,
}
{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_GetByEnrollmentAccount (new)
Description :  Gets a role assignment for the caller on a enrollment Account. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
enrollmentAccountName:
{
Description: The ID that uniquely identifies an enrollment account. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_DeleteByEnrollmentAccount (new)
Description :  Deletes a role assignment for the caller on a enrollment Account. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
enrollmentAccountName:
{
Description: The ID that uniquely identifies an enrollment account. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
EnrollmentAccountRoleAssignments_Put (new)
Description :  Create or update a billing role assignment.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
enrollmentAccountName:
{
Description: The ID that uniquely identifies an enrollment account. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
parameters:
{
Description: The new or updated billing role assignment. ,
Required: True ,
}
{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_ListByBillingAccount (new)
Description :  Lists the role assignments for the caller on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of role assignments. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_AddByBillingAccount (new)
Description :  Adds a role assignment on a billing account. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/createBillingRoleAssignment
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the create billing role assignment operation. ,
Required: True ,
}
{
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
billingRoleDefinitionId:
{
Description: The role definition id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
value:
{
Description: The list of role assignments. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_ListByInvoiceSection (new)
Description :  Lists the role assignments for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleAssignments
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of role assignments. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_AddByInvoiceSection (new)
Description :  Adds a role assignment on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/createBillingRoleAssignment
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the create billing role assignment operation. ,
Required: True ,
}
{
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
billingRoleDefinitionId:
{
Description: The role definition id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
value:
{
Description: The list of role assignments. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_ListByBillingProfile (new)
Description :  Lists the role assignments for the caller on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleAssignments
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of role assignments. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_AddByBillingProfile (new)
Description :  Adds a role assignment on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/createBillingRoleAssignment
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the create billing role assignment operation. ,
Required: True ,
}
{
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
billingRoleDefinitionId:
{
Description: The role definition id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
value:
{
Description: The list of role assignments. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_ListByDepartment (new)
Description :  Lists the role assignments for the caller on a billing profile. The operation is supported for billing accounts of type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingRoleAssignments
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
departmentName:
{
Description: The ID that uniquely identifies a department. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of role assignments. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_ListByEnrollmentAccount (new)
Description :  Lists the role assignments for the caller on a billing profile. The operation is supported for billing accounts of type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingRoleAssignments
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
enrollmentAccountName:
{
Description: The ID that uniquely identifies an enrollment account. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of role assignments. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Agreements_ListByBillingAccount (new)
Description :  Lists the agreements for a billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the participants. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of agreements. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an agreement. ,
Required: False ,
}
{
agreementLink:
{
Description: The URL to download the agreement. ,
Required: False ,
}
string ,
category:
{
Description: The category of the agreement signed by a customer. ,
Enum:
{
MicrosoftCustomerAgreement: No description available. ,
AffiliatePurchaseTerms: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
acceptanceMode:
{
Description: The mode of acceptance for an agreement. ,
Enum:
{
ClickToAccept: No description available. ,
ESignEmbedded: No description available. ,
ESignOffline: No description available. ,
}
,
Required: False ,
}
enum ,
effectiveDate:
{
Description: The date from which the agreement is effective. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date when the agreement expires. ,
Format: date-time ,
Required: False ,
}
string ,
participants:
{
Description: The list of participants that participates in acceptance of an agreement. ,
Required: False ,
}
[
{
status:
{
Description: The acceptance status of the participant. ,
Required: False ,
}
string ,
statusDate:
{
Description: The date when the status got changed. ,
Format: date-time ,
Required: False ,
}
string ,
email:
{
Description: The email address of the participant. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The current status of the agreement. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Agreements_Get (new)
Description :  Gets an agreement by ID.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements/{agreementName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
agreementName:
{
Description: The ID that uniquely identifies an agreement. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the participants. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an agreement. ,
Required: False ,
}
{
agreementLink:
{
Description: The URL to download the agreement. ,
Required: False ,
}
string ,
category:
{
Description: The category of the agreement signed by a customer. ,
Enum:
{
MicrosoftCustomerAgreement: No description available. ,
AffiliatePurchaseTerms: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
acceptanceMode:
{
Description: The mode of acceptance for an agreement. ,
Enum:
{
ClickToAccept: No description available. ,
ESignEmbedded: No description available. ,
ESignOffline: No description available. ,
}
,
Required: False ,
}
enum ,
effectiveDate:
{
Description: The date from which the agreement is effective. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date when the agreement expires. ,
Format: date-time ,
Required: False ,
}
string ,
participants:
{
Description: The list of participants that participates in acceptance of an agreement. ,
Required: False ,
}
[
{
status:
{
Description: The acceptance status of the participant. ,
Required: False ,
}
string ,
statusDate:
{
Description: The date when the status got changed. ,
Format: date-time ,
Required: False ,
}
string ,
email:
{
Description: The email address of the participant. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The current status of the agreement. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingAccounts_List (removed)
Description :  Lists the billing accounts that a user has access to.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the address, invoice sections and billing profiles. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing accounts. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing account. ,
Required: False ,
}
{
displayName:
{
Description: The billing account name. ,
Required: False ,
}
string ,
address:
{
Description: The address associated with the billing account. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
agreementType:
{
Description: The type of agreement. ,
Enum:
{
MicrosoftCustomerAgreement: No description available. ,
EnterpriseAgreement: No description available. ,
MicrosoftOnlineServicesProgram: No description available. ,
MicrosoftPartnerAgreement: No description available. ,
}
,
Required: False ,
}
enum ,
customerType:
{
Description: The type of customer. ,
Enum:
{
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
}
,
Required: False ,
}
enum ,
accountType:
{
Description: The type of customer. ,
Enum:
{
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfiles:
{
Description: The billing profiles associated with the billing account. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
poNumber:
{
Description: The purchase order name that will appear on the invoices generated for the billing profile. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
billingRelationshipType:
{
Description: Identifies which services and purchases are paid by a billing profile. ,
Enum:
{
Direct: No description available. ,
IndirectCustomer: No description available. ,
IndirectPartner: No description available. ,
CSPPartner: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceEmailOptIn:
{
Description: Flag controlling whether the invoices for the billing profile are sent through email. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: The day of the month when the invoice for the billing profile is generated. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Information about the enabled azure plans. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
indirectRelationshipInfo:
{
Description: Identifies the billing profile that is linked to another billing profile in indirect purchase motion. ,
Required: False ,
}
{
billingAccountName:
{
Description: The billing account name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The billing profile name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the partner or customer for an indirect motion. ,
Required: False ,
}
string ,
}
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an invoice section. ,
Required: False ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Enum:
{
USGov: No description available. ,
USNat: No description available. ,
USSec: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
status:
{
Description: The status of the billing profile. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
}
,
Required: False ,
}
enum ,
statusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
PastDue: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
spendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
targetClouds:
{
Description: Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
enrollmentDetails:
{
Description: The details about the associated legacy enrollment. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
startDate:
{
Description: The start date of the enrollment. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment. ,
Format: date-time ,
Required: False ,
}
string ,
currency:
{
Description: The billing currency for the enrollment. ,
Required: False ,
}
string ,
channel:
{
Description: The channel type of the enrollment. ,
Required: False ,
}
string ,
policies:
{
Description: The policies for Enterprise Agreement enrollments. ,
Required: False ,
}
{
accountOwnerViewCharges:
{
Description: The policy that controls whether Account Owners can view charges. ,
Required: False ,
}
boolean ,
departmentAdminViewCharges:
{
Description: The policy that controls whether Department Administrators can view charges. ,
Required: False ,
}
boolean ,
marketplacesEnabled:
{
Description: The policy that controls whether Azure marketplace purchases are allowed in the enrollment. ,
Required: False ,
}
boolean ,
reservedInstancesEnabled:
{
Description: The policy that controls whether Azure reservation purchases are allowed in the enrollment. ,
Required: False ,
}
boolean ,
}
,
language:
{
Description: The language for the enrollment. ,
Required: False ,
}
string ,
countryCode:
{
Description: The country code of the enrollment. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the enrollment. ,
Required: False ,
}
string ,
billingCycle:
{
Description: The billing cycle for the enrollment. ,
Required: False ,
}
string ,
}
,
departments:
{
Description: The departments associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: A department. ,
Required: False ,
}
{
departmentName:
{
Description: The name of the department. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the department. ,
Required: False ,
}
string ,
status:
{
Description: The status of the department. ,
Required: False ,
}
string ,
enrollmentAccounts:
{
Description: Associated enrollment accounts. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an enrollment account. ,
Required: False ,
}
{
accountName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The start date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
enrollmentAccounts:
{
Description: The accounts associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an enrollment account. ,
Required: False ,
}
{
accountName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The start date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
organizationId:
{
Description: Organization id. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingAccounts_Get (removed)
Description :  Gets a billing account by its ID.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the address, invoice sections and billing profiles. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the billing account. ,
Required: False ,
}
{
displayName:
{
Description: The billing account name. ,
Required: False ,
}
string ,
address:
{
Description: The address associated with the billing account. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
agreementType:
{
Description: The type of agreement. ,
Enum:
{
MicrosoftCustomerAgreement: No description available. ,
EnterpriseAgreement: No description available. ,
MicrosoftOnlineServicesProgram: No description available. ,
MicrosoftPartnerAgreement: No description available. ,
}
,
Required: False ,
}
enum ,
customerType:
{
Description: The type of customer. ,
Enum:
{
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
}
,
Required: False ,
}
enum ,
accountType:
{
Description: The type of customer. ,
Enum:
{
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfiles:
{
Description: The billing profiles associated with the billing account. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
poNumber:
{
Description: The purchase order name that will appear on the invoices generated for the billing profile. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
billingRelationshipType:
{
Description: Identifies which services and purchases are paid by a billing profile. ,
Enum:
{
Direct: No description available. ,
IndirectCustomer: No description available. ,
IndirectPartner: No description available. ,
CSPPartner: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceEmailOptIn:
{
Description: Flag controlling whether the invoices for the billing profile are sent through email. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: The day of the month when the invoice for the billing profile is generated. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Information about the enabled azure plans. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
indirectRelationshipInfo:
{
Description: Identifies the billing profile that is linked to another billing profile in indirect purchase motion. ,
Required: False ,
}
{
billingAccountName:
{
Description: The billing account name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The billing profile name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the partner or customer for an indirect motion. ,
Required: False ,
}
string ,
}
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an invoice section. ,
Required: False ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Enum:
{
USGov: No description available. ,
USNat: No description available. ,
USSec: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
status:
{
Description: The status of the billing profile. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
}
,
Required: False ,
}
enum ,
statusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
PastDue: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
spendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
targetClouds:
{
Description: Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
enrollmentDetails:
{
Description: The details about the associated legacy enrollment. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
startDate:
{
Description: The start date of the enrollment. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment. ,
Format: date-time ,
Required: False ,
}
string ,
currency:
{
Description: The billing currency for the enrollment. ,
Required: False ,
}
string ,
channel:
{
Description: The channel type of the enrollment. ,
Required: False ,
}
string ,
policies:
{
Description: The policies for Enterprise Agreement enrollments. ,
Required: False ,
}
{
accountOwnerViewCharges:
{
Description: The policy that controls whether Account Owners can view charges. ,
Required: False ,
}
boolean ,
departmentAdminViewCharges:
{
Description: The policy that controls whether Department Administrators can view charges. ,
Required: False ,
}
boolean ,
marketplacesEnabled:
{
Description: The policy that controls whether Azure marketplace purchases are allowed in the enrollment. ,
Required: False ,
}
boolean ,
reservedInstancesEnabled:
{
Description: The policy that controls whether Azure reservation purchases are allowed in the enrollment. ,
Required: False ,
}
boolean ,
}
,
language:
{
Description: The language for the enrollment. ,
Required: False ,
}
string ,
countryCode:
{
Description: The country code of the enrollment. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the enrollment. ,
Required: False ,
}
string ,
billingCycle:
{
Description: The billing cycle for the enrollment. ,
Required: False ,
}
string ,
}
,
departments:
{
Description: The departments associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: A department. ,
Required: False ,
}
{
departmentName:
{
Description: The name of the department. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the department. ,
Required: False ,
}
string ,
status:
{
Description: The status of the department. ,
Required: False ,
}
string ,
enrollmentAccounts:
{
Description: Associated enrollment accounts. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an enrollment account. ,
Required: False ,
}
{
accountName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The start date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
enrollmentAccounts:
{
Description: The accounts associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an enrollment account. ,
Required: False ,
}
{
accountName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The start date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
organizationId:
{
Description: Organization id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingAccounts_Update (removed)
Description :  Updates the properties of a billing account. Currently, displayName and address can be updated. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the update billing account operation. ,
Required: True ,
}
{
properties:
{
Description: A billing property. ,
Required: False ,
}
{
displayName:
{
Description: The billing account name. ,
Required: False ,
}
string ,
address:
{
Description: The address associated with the billing account. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
agreementType:
{
Description: The type of agreement. ,
Enum:
{
MicrosoftCustomerAgreement: No description available. ,
EnterpriseAgreement: No description available. ,
MicrosoftOnlineServicesProgram: No description available. ,
MicrosoftPartnerAgreement: No description available. ,
}
,
Required: False ,
}
enum ,
customerType:
{
Description: The type of customer. ,
Enum:
{
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
}
,
Required: False ,
}
enum ,
accountType:
{
Description: The type of customer. ,
Enum:
{
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfiles:
{
Description: The billing profiles associated with the billing account. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
poNumber:
{
Description: The purchase order name that will appear on the invoices generated for the billing profile. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
billingRelationshipType:
{
Description: Identifies which services and purchases are paid by a billing profile. ,
Enum:
{
Direct: No description available. ,
IndirectCustomer: No description available. ,
IndirectPartner: No description available. ,
CSPPartner: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceEmailOptIn:
{
Description: Flag controlling whether the invoices for the billing profile are sent through email. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: The day of the month when the invoice for the billing profile is generated. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Information about the enabled azure plans. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
indirectRelationshipInfo:
{
Description: Identifies the billing profile that is linked to another billing profile in indirect purchase motion. ,
Required: False ,
}
{
billingAccountName:
{
Description: The billing account name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The billing profile name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the partner or customer for an indirect motion. ,
Required: False ,
}
string ,
}
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an invoice section. ,
Required: False ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Enum:
{
USGov: No description available. ,
USNat: No description available. ,
USSec: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
status:
{
Description: The status of the billing profile. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
}
,
Required: False ,
}
enum ,
statusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
PastDue: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
spendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
targetClouds:
{
Description: Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
enrollmentDetails:
{
Description: The details about the associated legacy enrollment. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
startDate:
{
Description: The start date of the enrollment. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment. ,
Format: date-time ,
Required: False ,
}
string ,
currency:
{
Description: The billing currency for the enrollment. ,
Required: False ,
}
string ,
channel:
{
Description: The channel type of the enrollment. ,
Required: False ,
}
string ,
policies:
{
Description: The policies for Enterprise Agreement enrollments. ,
Required: False ,
}
{
accountOwnerViewCharges:
{
Description: The policy that controls whether Account Owners can view charges. ,
Required: False ,
}
boolean ,
departmentAdminViewCharges:
{
Description: The policy that controls whether Department Administrators can view charges. ,
Required: False ,
}
boolean ,
marketplacesEnabled:
{
Description: The policy that controls whether Azure marketplace purchases are allowed in the enrollment. ,
Required: False ,
}
boolean ,
reservedInstancesEnabled:
{
Description: The policy that controls whether Azure reservation purchases are allowed in the enrollment. ,
Required: False ,
}
boolean ,
}
,
language:
{
Description: The language for the enrollment. ,
Required: False ,
}
string ,
countryCode:
{
Description: The country code of the enrollment. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the enrollment. ,
Required: False ,
}
string ,
billingCycle:
{
Description: The billing cycle for the enrollment. ,
Required: False ,
}
string ,
}
,
departments:
{
Description: The departments associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: A department. ,
Required: False ,
}
{
departmentName:
{
Description: The name of the department. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the department. ,
Required: False ,
}
string ,
status:
{
Description: The status of the department. ,
Required: False ,
}
string ,
enrollmentAccounts:
{
Description: Associated enrollment accounts. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an enrollment account. ,
Required: False ,
}
{
accountName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The start date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
enrollmentAccounts:
{
Description: The accounts associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an enrollment account. ,
Required: False ,
}
{
accountName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The start date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
organizationId:
{
Description: Organization id. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the billing account. ,
Required: False ,
}
{
displayName:
{
Description: The billing account name. ,
Required: False ,
}
string ,
address:
{
Description: The address associated with the billing account. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
agreementType:
{
Description: The type of agreement. ,
Enum:
{
MicrosoftCustomerAgreement: No description available. ,
EnterpriseAgreement: No description available. ,
MicrosoftOnlineServicesProgram: No description available. ,
MicrosoftPartnerAgreement: No description available. ,
}
,
Required: False ,
}
enum ,
customerType:
{
Description: The type of customer. ,
Enum:
{
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
}
,
Required: False ,
}
enum ,
accountType:
{
Description: The type of customer. ,
Enum:
{
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfiles:
{
Description: The billing profiles associated with the billing account. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
poNumber:
{
Description: The purchase order name that will appear on the invoices generated for the billing profile. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
billingRelationshipType:
{
Description: Identifies which services and purchases are paid by a billing profile. ,
Enum:
{
Direct: No description available. ,
IndirectCustomer: No description available. ,
IndirectPartner: No description available. ,
CSPPartner: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceEmailOptIn:
{
Description: Flag controlling whether the invoices for the billing profile are sent through email. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: The day of the month when the invoice for the billing profile is generated. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Information about the enabled azure plans. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
indirectRelationshipInfo:
{
Description: Identifies the billing profile that is linked to another billing profile in indirect purchase motion. ,
Required: False ,
}
{
billingAccountName:
{
Description: The billing account name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The billing profile name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the partner or customer for an indirect motion. ,
Required: False ,
}
string ,
}
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an invoice section. ,
Required: False ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Enum:
{
USGov: No description available. ,
USNat: No description available. ,
USSec: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
status:
{
Description: The status of the billing profile. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
}
,
Required: False ,
}
enum ,
statusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
PastDue: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
spendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
targetClouds:
{
Description: Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
enrollmentDetails:
{
Description: The details about the associated legacy enrollment. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
startDate:
{
Description: The start date of the enrollment. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment. ,
Format: date-time ,
Required: False ,
}
string ,
currency:
{
Description: The billing currency for the enrollment. ,
Required: False ,
}
string ,
channel:
{
Description: The channel type of the enrollment. ,
Required: False ,
}
string ,
policies:
{
Description: The policies for Enterprise Agreement enrollments. ,
Required: False ,
}
{
accountOwnerViewCharges:
{
Description: The policy that controls whether Account Owners can view charges. ,
Required: False ,
}
boolean ,
departmentAdminViewCharges:
{
Description: The policy that controls whether Department Administrators can view charges. ,
Required: False ,
}
boolean ,
marketplacesEnabled:
{
Description: The policy that controls whether Azure marketplace purchases are allowed in the enrollment. ,
Required: False ,
}
boolean ,
reservedInstancesEnabled:
{
Description: The policy that controls whether Azure reservation purchases are allowed in the enrollment. ,
Required: False ,
}
boolean ,
}
,
language:
{
Description: The language for the enrollment. ,
Required: False ,
}
string ,
countryCode:
{
Description: The country code of the enrollment. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the enrollment. ,
Required: False ,
}
string ,
billingCycle:
{
Description: The billing cycle for the enrollment. ,
Required: False ,
}
string ,
}
,
departments:
{
Description: The departments associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: A department. ,
Required: False ,
}
{
departmentName:
{
Description: The name of the department. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the department. ,
Required: False ,
}
string ,
status:
{
Description: The status of the department. ,
Required: False ,
}
string ,
enrollmentAccounts:
{
Description: Associated enrollment accounts. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an enrollment account. ,
Required: False ,
}
{
accountName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The start date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
enrollmentAccounts:
{
Description: The accounts associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an enrollment account. ,
Required: False ,
}
{
accountName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The start date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
organizationId:
{
Description: Organization id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingAccounts_ListInvoiceSectionsByCreateSubscriptionPermission (removed)
Description :  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.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/listInvoiceSectionsWithCreateSubscriptionPermission
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of invoice section properties with create subscription permission. ,
Required: False ,
}
[
{
invoiceSectionId:
{
Description: The ID of the invoice section. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile for the invoice section. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile for the invoice section. ,
Required: False ,
}
string ,
billingProfileStatus:
{
Description: The status of the billing profile. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfileStatusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
PastDue: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfileSpendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
enabledAzurePlans:
{
Description: Enabled azure plans for the associated billing profile. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
PaymentMethods_ListByBillingAccount (removed)
Description :  Lists the payment Methods for a billing account. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/paymentMethods
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of payment methods. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a payment method. ,
Required: False ,
}
{
paymentMethodType:
{
Description: The type of payment method. ,
Enum:
{
Credits: No description available. ,
ChequeWire: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Details about the payment method. ,
Required: False ,
}
string ,
expiration:
{
Description: Expiration month and year. ,
Required: False ,
}
string ,
currency:
{
Description: The currency associated with the payment method. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Address_Validate (removed)
Description :  Validates an address. Use the operation to validate an address before using it as a billing account or a billing profile address.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/validateAddress
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
address:
{
Required: True ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
status:
{
Description: status of the address validation. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
}
,
Required: False ,
}
enum ,
suggestedAddresses:
{
Description: The list of suggested addresses. ,
Required: False ,
}
[
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
]
,
validationMessage:
{
Description: Validation error message. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
AvailableBalances_GetByBillingProfile (removed)
Description :  The available credit balance for a billing profile. This is the balance that can be used for pay now to settle due or past due invoices. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/availableBalance/default
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of available balance. ,
Required: False ,
}
{
amount:
{
Description: Balance amount. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Instructions_ListByBillingProfile (removed)
Description :  Lists the instructions by billing profile id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/instructions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing instructions used during invoice generation. ,
Required: False ,
}
[
{
properties:
{
Description: A billing instruction used during invoice generation. ,
Required: False ,
}
{
amount:
{
Description: The amount budgeted for this billing instruction. ,
Required: True ,
}
number ,
startDate:
{
Description: The date this billing instruction goes into effect. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The date this billing instruction is no longer in effect. ,
Format: date-time ,
Required: True ,
}
string ,
creationDate:
{
Description: The date this billing instruction was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Instructions_Get (removed)
Description :  Get the instruction by name. These are custom billing instructions and are only applicable for certain customers.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/instructions/{instructionName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
instructionName:
{
Description: Instruction Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A billing instruction used during invoice generation. ,
Required: False ,
}
{
amount:
{
Description: The amount budgeted for this billing instruction. ,
Required: True ,
}
number ,
startDate:
{
Description: The date this billing instruction goes into effect. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The date this billing instruction is no longer in effect. ,
Format: date-time ,
Required: True ,
}
string ,
creationDate:
{
Description: The date this billing instruction was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Instructions_Put (removed)
Description :  Creates or updates an instruction. These are custom billing instructions and are only applicable for certain customers.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/instructions/{instructionName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
instructionName:
{
Description: Instruction Name. ,
Required: True ,
}
string ,
parameters:
{
Description: The new instruction. ,
Required: True ,
}
{
properties:
{
Description: A billing instruction used during invoice generation. ,
Required: False ,
}
{
amount:
{
Description: The amount budgeted for this billing instruction. ,
Required: True ,
}
number ,
startDate:
{
Description: The date this billing instruction goes into effect. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The date this billing instruction is no longer in effect. ,
Format: date-time ,
Required: True ,
}
string ,
creationDate:
{
Description: The date this billing instruction was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A billing instruction used during invoice generation. ,
Required: False ,
}
{
amount:
{
Description: The amount budgeted for this billing instruction. ,
Required: True ,
}
number ,
startDate:
{
Description: The date this billing instruction goes into effect. ,
Format: date-time ,
Required: True ,
}
string ,
endDate:
{
Description: The date this billing instruction is no longer in effect. ,
Format: date-time ,
Required: True ,
}
string ,
creationDate:
{
Description: The date this billing instruction was created. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
PaymentMethods_ListByBillingProfile (removed)
Description :  Lists the payment Methods for a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/paymentMethods
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of payment methods. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a payment method. ,
Required: False ,
}
{
paymentMethodType:
{
Description: The type of payment method. ,
Enum:
{
Credits: No description available. ,
ChequeWire: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Details about the payment method. ,
Required: False ,
}
string ,
expiration:
{
Description: Expiration month and year. ,
Required: False ,
}
string ,
currency:
{
Description: The currency associated with the payment method. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingProfiles_GetEligibilityToDetachPaymentMethod (removed)
Description :  Validates if the default payment method can be detached from the billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/validateDetachPaymentMethodEligibility
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
isEligible:
{
Description: Specifies whether the payment method is eligible to be detached from the billing profile. ,
Required: False ,
}
boolean ,
errorDetails:
{
Description: The list of detach payment method eligibility errors. ,
Required: False ,
}
[
{
code:
{
Description: Error code for the detach payment method eligibility validation. ,
Enum:
{
AzureSubscriptions: No description available. ,
RecurringCharges: No description available. ,
ReservedInstances: No description available. ,
OutstandingCharges: No description available. ,
PendingCharges: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Error message for the detach payment method eligibility validation. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingProfiles_ListByBillingAccount (removed)
Description :  Lists the billing profiles that a user has access to. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the invoice sections. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing profiles. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
poNumber:
{
Description: The purchase order name that will appear on the invoices generated for the billing profile. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
billingRelationshipType:
{
Description: Identifies which services and purchases are paid by a billing profile. ,
Enum:
{
Direct: No description available. ,
IndirectCustomer: No description available. ,
IndirectPartner: No description available. ,
CSPPartner: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceEmailOptIn:
{
Description: Flag controlling whether the invoices for the billing profile are sent through email. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: The day of the month when the invoice for the billing profile is generated. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Information about the enabled azure plans. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
indirectRelationshipInfo:
{
Description: Identifies the billing profile that is linked to another billing profile in indirect purchase motion. ,
Required: False ,
}
{
billingAccountName:
{
Description: The billing account name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The billing profile name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the partner or customer for an indirect motion. ,
Required: False ,
}
string ,
}
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an invoice section. ,
Required: False ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Enum:
{
USGov: No description available. ,
USNat: No description available. ,
USSec: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
status:
{
Description: The status of the billing profile. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
}
,
Required: False ,
}
enum ,
statusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
PastDue: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
spendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
targetClouds:
{
Description: Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingProfiles_Get (removed)
Description :  Gets a billing profile by its ID. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the invoice sections. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
poNumber:
{
Description: The purchase order name that will appear on the invoices generated for the billing profile. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
billingRelationshipType:
{
Description: Identifies which services and purchases are paid by a billing profile. ,
Enum:
{
Direct: No description available. ,
IndirectCustomer: No description available. ,
IndirectPartner: No description available. ,
CSPPartner: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceEmailOptIn:
{
Description: Flag controlling whether the invoices for the billing profile are sent through email. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: The day of the month when the invoice for the billing profile is generated. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Information about the enabled azure plans. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
indirectRelationshipInfo:
{
Description: Identifies the billing profile that is linked to another billing profile in indirect purchase motion. ,
Required: False ,
}
{
billingAccountName:
{
Description: The billing account name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The billing profile name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the partner or customer for an indirect motion. ,
Required: False ,
}
string ,
}
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an invoice section. ,
Required: False ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Enum:
{
USGov: No description available. ,
USNat: No description available. ,
USSec: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
status:
{
Description: The status of the billing profile. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
}
,
Required: False ,
}
enum ,
statusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
PastDue: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
spendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
targetClouds:
{
Description: Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingProfiles_Create (removed)
Description :  Creates a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the create billing profile operation. ,
Required: True ,
}
{
displayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
poNumber:
{
Description: The purchase order name that will appear on the invoices generated for the billing profile. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: Flag controlling whether the invoices for the billing profile are sent through email. ,
Required: False ,
}
boolean ,
enabledAzurePlans:
{
Description: Enabled azure plans for the billing profile. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
poNumber:
{
Description: The purchase order name that will appear on the invoices generated for the billing profile. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
billingRelationshipType:
{
Description: Identifies which services and purchases are paid by a billing profile. ,
Enum:
{
Direct: No description available. ,
IndirectCustomer: No description available. ,
IndirectPartner: No description available. ,
CSPPartner: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceEmailOptIn:
{
Description: Flag controlling whether the invoices for the billing profile are sent through email. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: The day of the month when the invoice for the billing profile is generated. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Information about the enabled azure plans. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
indirectRelationshipInfo:
{
Description: Identifies the billing profile that is linked to another billing profile in indirect purchase motion. ,
Required: False ,
}
{
billingAccountName:
{
Description: The billing account name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The billing profile name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the partner or customer for an indirect motion. ,
Required: False ,
}
string ,
}
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an invoice section. ,
Required: False ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Enum:
{
USGov: No description available. ,
USNat: No description available. ,
USSec: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
status:
{
Description: The status of the billing profile. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
}
,
Required: False ,
}
enum ,
statusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
PastDue: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
spendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
targetClouds:
{
Description: Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result ,
}
string ,
retry-after:
{
Description: Recommended time to wait before making another request to check the status of the operation. The time is specified in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingProfiles_Update (removed)
Description :  Updates the properties of a billing profile. Currently, displayName, poNumber, bill-to address and invoiceEmailOptIn can be updated. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters supplied to the update billing profile operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of the billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
poNumber:
{
Description: The purchase order name that will appear on the invoices generated for the billing profile. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
billingRelationshipType:
{
Description: Identifies which services and purchases are paid by a billing profile. ,
Enum:
{
Direct: No description available. ,
IndirectCustomer: No description available. ,
IndirectPartner: No description available. ,
CSPPartner: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceEmailOptIn:
{
Description: Flag controlling whether the invoices for the billing profile are sent through email. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: The day of the month when the invoice for the billing profile is generated. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Information about the enabled azure plans. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
indirectRelationshipInfo:
{
Description: Identifies the billing profile that is linked to another billing profile in indirect purchase motion. ,
Required: False ,
}
{
billingAccountName:
{
Description: The billing account name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The billing profile name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the partner or customer for an indirect motion. ,
Required: False ,
}
string ,
}
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an invoice section. ,
Required: False ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Enum:
{
USGov: No description available. ,
USNat: No description available. ,
USSec: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
status:
{
Description: The status of the billing profile. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
}
,
Required: False ,
}
enum ,
statusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
PastDue: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
spendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
targetClouds:
{
Description: Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The name of the billing profile. ,
Required: False ,
}
string ,
poNumber:
{
Description: The purchase order name that will appear on the invoices generated for the billing profile. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
}
,
billingRelationshipType:
{
Description: Identifies which services and purchases are paid by a billing profile. ,
Enum:
{
Direct: No description available. ,
IndirectCustomer: No description available. ,
IndirectPartner: No description available. ,
CSPPartner: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceEmailOptIn:
{
Description: Flag controlling whether the invoices for the billing profile are sent through email. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: The day of the month when the invoice for the billing profile is generated. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency in which the charges for the billing profile are billed. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Information about the enabled azure plans. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
indirectRelationshipInfo:
{
Description: Identifies the billing profile that is linked to another billing profile in indirect purchase motion. ,
Required: False ,
}
{
billingAccountName:
{
Description: The billing account name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The billing profile name of the partner or the customer for an indirect motion. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the partner or customer for an indirect motion. ,
Required: False ,
}
string ,
}
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an invoice section. ,
Required: False ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Enum:
{
USGov: No description available. ,
USNat: No description available. ,
USSec: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
status:
{
Description: The status of the billing profile. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
}
,
Required: False ,
}
enum ,
statusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
PastDue: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
spendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
targetClouds:
{
Description: Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: GET this URL to retrieve the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Customers_ListByBillingProfile (removed)
Description :  Lists the customers that are billed to a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter the list of customers. ,
Required: False ,
}
string ,
$skiptoken:
{
Description: Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of customers. ,
Required: False ,
}
[
{
properties:
{
Description: The customer. ,
Required: False ,
}
{
displayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Azure plans enabled for the customer. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
resellers:
{
Description: The list of resellers for which an Azure plan is enabled for the customer. ,
Required: False ,
}
[
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
InvoiceSections_ListByBillingProfile (removed)
Description :  Lists the invoice sections that a user has access to. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of invoice sections. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an invoice section. ,
Required: False ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Enum:
{
USGov: No description available. ,
USNat: No description available. ,
USSec: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
InvoiceSections_Get (removed)
Description :  Gets an invoice section by its ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an invoice section. ,
Required: False ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Enum:
{
USGov: No description available. ,
USNat: No description available. ,
USSec: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
InvoiceSections_Create (removed)
Description :  Creates an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the create invoice section operation. ,
Required: True ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an invoice section. ,
Required: False ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Enum:
{
USGov: No description available. ,
USNat: No description available. ,
USSec: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result ,
}
string ,
retry-after:
{
Description: Recommended time to wait before making another request to check the status of the operation. The time is specified in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
InvoiceSections_Update (removed)
Description :  Updates an invoice section. Currently, only displayName can be updated. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the update invoice section operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of an invoice section. ,
Required: False ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Enum:
{
USGov: No description available. ,
USNat: No description available. ,
USSec: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an invoice section. ,
Required: False ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
targetCloud:
{
Description: Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. ,
Enum:
{
USGov: No description available. ,
USNat: No description available. ,
USSec: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: GET this URL to retrieve the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Customers_ListByBillingAccount (removed)
Description :  Lists the customers that are billed to a billing account. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter the list of customers. ,
Required: False ,
}
string ,
$skiptoken:
{
Description: Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of customers. ,
Required: False ,
}
[
{
properties:
{
Description: The customer. ,
Required: False ,
}
{
displayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Azure plans enabled for the customer. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
resellers:
{
Description: The list of resellers for which an Azure plan is enabled for the customer. ,
Required: False ,
}
[
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Customers_Get (removed)
Description :  Gets a customer by its ID. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand enabledAzurePlans and resellers ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The customer. ,
Required: False ,
}
{
displayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
enabledAzurePlans:
{
Description: Azure plans enabled for the customer. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
resellers:
{
Description: The list of resellers for which an Azure plan is enabled for the customer. ,
Required: False ,
}
[
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingPermissions_ListByCustomer (removed)
Description :  Lists the billing permissions the caller has for a customer.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/billingPermissions
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billingPermissions a caller has on a billing account. ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingSubscriptions_ListByCustomer (removed)
Description :  Lists the subscriptions for a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/billingSubscriptions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing subscriptions. ,
Required: False ,
}
[
{
properties:
{
Description: The billing properties of a subscription. ,
Required: False ,
}
{
displayName:
{
Description: The name of the subscription. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription. ,
Format: uuid ,
Required: False ,
}
string ,
subscriptionBillingStatus:
{
Description: The current billing status of the subscription. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
Abandoned: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
lastMonthCharges:
{
Description: The last month charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billingProfileId:
{
Description: The ID of the billing profile to which the subscription is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the subscription is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the subscription is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the subscription is billed. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this subscription. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The sku ID of the Azure plan for the subscription. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the Azure plan for the subscription. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingSubscriptions_GetByCustomer (removed)
Description :  Gets a subscription by its ID. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/billingSubscriptions/{billingSubscriptionName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: The ID that uniquely identifies a subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The billing properties of a subscription. ,
Required: False ,
}
{
displayName:
{
Description: The name of the subscription. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription. ,
Format: uuid ,
Required: False ,
}
string ,
subscriptionBillingStatus:
{
Description: The current billing status of the subscription. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
Abandoned: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
lastMonthCharges:
{
Description: The last month charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billingProfileId:
{
Description: The ID of the billing profile to which the subscription is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the subscription is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the subscription is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the subscription is billed. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this subscription. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The sku ID of the Azure plan for the subscription. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the Azure plan for the subscription. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Products_ListByCustomer (removed)
Description :  Lists the products for a customer. These don't include products billed based on usage.The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/products
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter by product type. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value are separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of products. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a product. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date when the product was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the type of product. ,
Required: False ,
}
string ,
productType:
{
Description: The description of the type of product. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the product. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
PastDue: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
Disabled: No description available. ,
Cancelled: No description available. ,
AutoRenew: No description available. ,
}
,
Required: False ,
}
enum ,
endDate:
{
Description: The date when the product will be renewed or canceled. ,
Format: date-time ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The frequency at which the product will be billed. ,
Enum:
{
OneTime: No description available. ,
Monthly: No description available. ,
UsageBased: No description available. ,
}
,
Required: False ,
}
enum ,
lastCharge:
{
Description: The last month charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
lastChargeDate:
{
Description: The date of the last charge. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased for the product. ,
Required: False ,
}
number ,
skuId:
{
Description: The sku ID of the product. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the product. ,
Required: False ,
}
string ,
tenantId:
{
Description: The id of the tenant in which the product is used. ,
Required: False ,
}
string ,
availabilityId:
{
Description: The availability of the product. ,
Required: False ,
}
string ,
parentProductId:
{
Description: Parent product Id. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this product. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Products_GetByCustomer (removed)
Description :  Gets a product by ID. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/products/{productName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
productName:
{
Description: The ID that uniquely identifies a product. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a product. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date when the product was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the type of product. ,
Required: False ,
}
string ,
productType:
{
Description: The description of the type of product. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the product. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
PastDue: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
Disabled: No description available. ,
Cancelled: No description available. ,
AutoRenew: No description available. ,
}
,
Required: False ,
}
enum ,
endDate:
{
Description: The date when the product will be renewed or canceled. ,
Format: date-time ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The frequency at which the product will be billed. ,
Enum:
{
OneTime: No description available. ,
Monthly: No description available. ,
UsageBased: No description available. ,
}
,
Required: False ,
}
enum ,
lastCharge:
{
Description: The last month charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
lastChargeDate:
{
Description: The date of the last charge. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased for the product. ,
Required: False ,
}
number ,
skuId:
{
Description: The sku ID of the product. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the product. ,
Required: False ,
}
string ,
tenantId:
{
Description: The id of the tenant in which the product is used. ,
Required: False ,
}
string ,
availabilityId:
{
Description: The availability of the product. ,
Required: False ,
}
string ,
parentProductId:
{
Description: Parent product Id. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this product. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Transactions_ListByCustomer (removed)
Description :  Lists the billed and unbilled transactions by customer id for given start date and end date. Transactions include purchases, refunds and Azure usage charges. Unbilled transactions are listed under pending invoice Id and do not include tax. Tax is added to the amount once an invoice is generated.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/transactions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Required: True ,
}
string ,
periodEndDate:
{
Description: The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter by transaction type. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value are separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of transactions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a transaction. ,
Required: False ,
}
{
kind:
{
Description: The kind of transaction. Options are all or reservation. ,
Enum:
{
all: No description available. ,
reservation: No description available. ,
}
,
Required: False ,
}
enum ,
date:
{
Description: The date of transaction. ,
Format: date-time ,
Required: False ,
}
string ,
invoice:
{
Description: Invoice on which the transaction was billed or 'pending' if the transaction is not billed. ,
Required: False ,
}
string ,
orderId:
{
Description: The order ID of the reservation. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
orderName:
{
Description: The name of the reservation order. The field is only applicable for transactions of kind reservation. ,
Required: False ,
}
string ,
productFamily:
{
Description: The family of the product for which the transaction took place. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product type for which the transaction took place. ,
Required: False ,
}
string ,
productType:
{
Description: The type of the product for which the transaction took place. ,
Required: False ,
}
string ,
productDescription:
{
Description: The description of the product for which the transaction took place. ,
Required: False ,
}
string ,
transactionType:
{
Description: The type of transaction. ,
Enum:
{
Purchase: No description available. ,
Usage Charge: No description available. ,
}
,
Required: False ,
}
enum ,
transactionAmount:
{
Description: The charge associated with the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
quantity:
{
Description: The quantity purchased in the transaction. ,
Format: int32 ,
Required: False ,
}
integer ,
invoiceSectionId:
{
Description: The ID of the invoice section which will be billed for the transaction. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section which will be billed for the transaction. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile which will be billed for the transaction. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile which will be billed for the transaction. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The name of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
azureCreditApplied:
{
Description: The amount of any Azure credits automatically applied to this transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billingCurrency:
{
Description: The ISO 4217 code for the currency in which this transaction is billed. ,
Required: False ,
}
string ,
discount:
{
Description: The percentage discount, if any, applied to this transaction. ,
Required: False ,
}
number ,
effectivePrice:
{
Description: The price of the product after applying any discounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
exchangeRate:
{
Description: The exchange rate used to convert charged amount to billing currency, if applicable. ,
Required: False ,
}
number ,
marketPrice:
{
Description: The retail price of the product. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
pricingCurrency:
{
Description: The ISO 4217 code for the currency in which the product is priced. ,
Required: False ,
}
string ,
servicePeriodStartDate:
{
Description: The date of the purchase of the product, or the start date of the month in which usage started. ,
Format: date-time ,
Required: False ,
}
string ,
servicePeriodEndDate:
{
Description: The end date of the product term, or the end date of the month in which usage ended. ,
Format: date-time ,
Required: False ,
}
string ,
subTotal:
{
Description: The pre-tax charged amount for the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
tax:
{
Description: The tax amount applied to the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
unitOfMeasure:
{
Description: The unit of measure used to bill for the product. For example, compute services are billed per hour. ,
Required: False ,
}
string ,
units:
{
Description: The number of units used for a given product. ,
Required: False ,
}
number ,
unitType:
{
Description: The description for the unit of measure for a given product. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Departments_ListByBillingAccountName (removed)
Description :  Lists the departments that a user has access to. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the enrollment accounts. ,
Required: False ,
}
string ,
$filter:
{
Description: May be used to filter by department name. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value are separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of departments. ,
Required: False ,
}
[
{
properties:
{
Description: A department. ,
Required: False ,
}
{
departmentName:
{
Description: The name of the department. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the department. ,
Required: False ,
}
string ,
status:
{
Description: The status of the department. ,
Required: False ,
}
string ,
enrollmentAccounts:
{
Description: Associated enrollment accounts. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an enrollment account. ,
Required: False ,
}
{
accountName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The start date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Departments_Get (removed)
Description :  Gets a department by ID. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
departmentName:
{
Description: The ID that uniquely identifies a department. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the enrollment accounts. ,
Required: False ,
}
string ,
$filter:
{
Description: May be used to filter by department name. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value are separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A department. ,
Required: False ,
}
{
departmentName:
{
Description: The name of the department. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the department. ,
Required: False ,
}
string ,
status:
{
Description: The status of the department. ,
Required: False ,
}
string ,
enrollmentAccounts:
{
Description: Associated enrollment accounts. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an enrollment account. ,
Required: False ,
}
{
accountName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The start date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
EnrollmentAccounts_ListByBillingAccountName (removed)
Description :  Lists the enrollment accounts for a billing account. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the department. ,
Required: False ,
}
string ,
$filter:
{
Description: May be used to filter by account name. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value are separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of enrollment accounts. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an enrollment account. ,
Required: False ,
}
{
accountName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The start date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
EnrollmentAccounts_GetByEnrollmentAccountId (removed)
Description :  Gets an enrollment account by ID. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
enrollmentAccountName:
{
Description: The ID that uniquely identifies an enrollment account. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the department. ,
Required: False ,
}
string ,
$filter:
{
Description: May be used to filter by account name. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value are separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an enrollment account. ,
Required: False ,
}
{
accountName:
{
Description: The name of the enrollment account. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center associated with the enrollment account. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The owner of the enrollment account. ,
Required: False ,
}
string ,
status:
{
Description: The status of the enrollment account. ,
Required: False ,
}
string ,
startDate:
{
Description: The start date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: The end date of the enrollment account. ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Invoices_ListByBillingAccount (removed)
Description :  Lists the invoices for a billing account for a given start date and end date. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: The start date to fetch the invoices. The date should be specified in MM-DD-YYYY format. ,
Required: True ,
}
string ,
periodEndDate:
{
Description: The end date to fetch the invoices. The date should be specified in MM-DD-YYYY format. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of invoices. ,
Required: False ,
}
[
{
properties:
{
Description: An invoice. ,
Required: False ,
}
{
dueDate:
{
Description: The due date for the invoice. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceDate:
{
Description: The date when the invoice was generated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the invoice. ,
Enum:
{
Due: No description available. ,
OverDue: No description available. ,
Paid: No description available. ,
Void: No description available. ,
}
,
Required: False ,
}
enum ,
amountDue:
{
Description: The amount due as of now. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
azurePrepaymentApplied:
{
Description: The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billedAmount:
{
Description: The total charges for the invoice billing period. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
creditAmount:
{
Description: 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. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
freeAzureCreditApplied:
{
Description: The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
subTotal:
{
Description: The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
taxAmount:
{
Description: The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
totalAmount:
{
Description: The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
invoicePeriodStartDate:
{
Description: The start date of the billing period for which the invoice is generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end date of the billing period for which the invoice is generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceType:
{
Description: Invoice type. ,
Enum:
{
AzureService: No description available. ,
AzureMarketplace: No description available. ,
AzureSupport: No description available. ,
}
,
Required: False ,
}
enum ,
isMonthlyInvoice:
{
Description: Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
boolean ,
billingProfileId:
{
Description: The ID of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
purchaseOrderNumber:
{
Description: An optional purchase order number for the invoice. ,
Required: False ,
}
string ,
documents:
{
Description: List of documents available to download such as invoice and tax receipt. ,
Required: False ,
}
[
{
kind:
{
Description: The type of the document. ,
Enum:
{
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: Document URL. ,
Required: False ,
}
string ,
documentNumbers:
{
Description: Document numbers for an Enterprise Agreement invoice. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
payments:
{
Description: List of payments. ,
Required: False ,
}
[
{
paymentType:
{
Description: The type of payment. ,
Required: False ,
}
string ,
amount:
{
Description: The paid amount. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
date:
{
Description: The date when the payment was made. ,
Format: date-time ,
Required: False ,
}
string ,
paymentMethodFamily:
{
Description: The family of payment method. ,
Enum:
{
Credits: No description available. ,
CheckWire: No description available. ,
CreditCard: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
}
,
]
,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
Required: False ,
}
string ,
rebillDetails:
{
Description: Rebill details of an Enterprise Agreement invoice. ,
Required: False ,
}
{
rebillDocumentType:
{
Description: The type of the document generated when an Enterprise Agreement invoice is rebilled. ,
Enum:
{
Credit: No description available. ,
Rebill: No description available. ,
Original: No description available. ,
}
,
Required: False ,
}
enum ,
rebilledInvoiceId:
{
Description: The ID of the invoice generated when an Enterprise Agreement invoice is rebilled. ,
Required: False ,
}
string ,
latestInvoiceId:
{
Description: The ID of the latest invoice generated when an Enterprise Agreement invoice is rebilled. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Invoices_DownloadMultipleEAInvoices (removed)
Description :  Gets a URL to download multiple invoice documents (invoice pdf, tax receipts, credit notes) as a zip file.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/downloadDocuments
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
downloadUrls:
{
Description: An array of download urls for individual documents. The download url paths in the request body should match the path of the original request. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: GET this URL to retrieve the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
string ,
}

⚐ Response (200)

{
expiryTime:
{
Description: The time in UTC when the download URL will expire. ,
Format: date-time ,
Required: False ,
}
string ,
url:
{
Description: The URL to the PDF file. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Invoices_GetBillingAccountInvoice (removed)
Description :  Gets an invoice by billing account name and ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
invoiceName:
{
Description: The ID that uniquely identifies an invoice. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: An invoice. ,
Required: False ,
}
{
dueDate:
{
Description: The due date for the invoice. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceDate:
{
Description: The date when the invoice was generated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the invoice. ,
Enum:
{
Due: No description available. ,
OverDue: No description available. ,
Paid: No description available. ,
Void: No description available. ,
}
,
Required: False ,
}
enum ,
amountDue:
{
Description: The amount due as of now. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
azurePrepaymentApplied:
{
Description: The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billedAmount:
{
Description: The total charges for the invoice billing period. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
creditAmount:
{
Description: 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. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
freeAzureCreditApplied:
{
Description: The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
subTotal:
{
Description: The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
taxAmount:
{
Description: The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
totalAmount:
{
Description: The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
invoicePeriodStartDate:
{
Description: The start date of the billing period for which the invoice is generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end date of the billing period for which the invoice is generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceType:
{
Description: Invoice type. ,
Enum:
{
AzureService: No description available. ,
AzureMarketplace: No description available. ,
AzureSupport: No description available. ,
}
,
Required: False ,
}
enum ,
isMonthlyInvoice:
{
Description: Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
boolean ,
billingProfileId:
{
Description: The ID of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
purchaseOrderNumber:
{
Description: An optional purchase order number for the invoice. ,
Required: False ,
}
string ,
documents:
{
Description: List of documents available to download such as invoice and tax receipt. ,
Required: False ,
}
[
{
kind:
{
Description: The type of the document. ,
Enum:
{
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: Document URL. ,
Required: False ,
}
string ,
documentNumbers:
{
Description: Document numbers for an Enterprise Agreement invoice. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
payments:
{
Description: List of payments. ,
Required: False ,
}
[
{
paymentType:
{
Description: The type of payment. ,
Required: False ,
}
string ,
amount:
{
Description: The paid amount. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
date:
{
Description: The date when the payment was made. ,
Format: date-time ,
Required: False ,
}
string ,
paymentMethodFamily:
{
Description: The family of payment method. ,
Enum:
{
Credits: No description available. ,
CheckWire: No description available. ,
CreditCard: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
}
,
]
,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
Required: False ,
}
string ,
rebillDetails:
{
Description: Rebill details of an Enterprise Agreement invoice. ,
Required: False ,
}
{
rebillDocumentType:
{
Description: The type of the document generated when an Enterprise Agreement invoice is rebilled. ,
Enum:
{
Credit: No description available. ,
Rebill: No description available. ,
Original: No description available. ,
}
,
Required: False ,
}
enum ,
rebilledInvoiceId:
{
Description: The ID of the invoice generated when an Enterprise Agreement invoice is rebilled. ,
Required: False ,
}
string ,
latestInvoiceId:
{
Description: The ID of the latest invoice generated when an Enterprise Agreement invoice is rebilled. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Invoices_DownloadMultipleBillingSubscriptionInvoices (removed)
Description :  Gets a URL to download multiple invoice documents (invoice pdf, tax receipts, credit notes) as a zip file.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/downloadDocuments
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID that uniquely identifies an Azure subscription. ,
Required: True ,
}
string ,
downloadUrls:
{
Description: An array of download urls for individual documents. The download url paths in the request body should match the path of the original request. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: GET this URL to retrieve the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
string ,
}

⚐ Response (200)

{
expiryTime:
{
Description: The time in UTC when the download URL will expire. ,
Format: date-time ,
Required: False ,
}
string ,
url:
{
Description: The URL to the PDF file. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
PriceSheet_Download (removed)
Description :  Gets a URL to download the pricesheet for an invoice. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices/{invoiceName}/pricesheet/default/download
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceName:
{
Description: The ID that uniquely identifies an invoice. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: GET this URL to retrieve the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
string ,
odata-entityid:
{
Description: The operation entity Id GUID. ,
}
string ,
}

⚐ Response (200)

{
expiryTime:
{
Description: The time in UTC when the download URL will expire. ,
Format: date-time ,
Required: False ,
}
string ,
url:
{
Description: The URL to the PDF file. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
PriceSheet_DownloadByBillingProfile (removed)
Description :  Gets a URL to download the current month's pricesheet for a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.This API is hereby deprecated in favor of https://docs.microsoft.com/en-us/rest/api/cost-management/2022-02-01-preview/price-sheet/download-by-billing-profile. We highly recommend you move to the new preview version, as the csv file in the current preview version will have 500k max size that cannot scale with Azure product growth.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/pricesheet/default/download
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: GET this URL to retrieve the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
string ,
odata-entityid:
{
Description: The operation entity Id GUID. ,
}
string ,
}

⚐ Response (200)

{
expiryTime:
{
Description: The time in UTC when the download URL will expire. ,
Format: date-time ,
Required: False ,
}
string ,
url:
{
Description: The URL to the PDF file. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Invoices_ListByBillingProfile (removed)
Description :  Lists the invoices for a billing profile for a given start date and end date. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: The start date to fetch the invoices. The date should be specified in MM-DD-YYYY format. ,
Required: True ,
}
string ,
periodEndDate:
{
Description: The end date to fetch the invoices. The date should be specified in MM-DD-YYYY format. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of invoices. ,
Required: False ,
}
[
{
properties:
{
Description: An invoice. ,
Required: False ,
}
{
dueDate:
{
Description: The due date for the invoice. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceDate:
{
Description: The date when the invoice was generated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the invoice. ,
Enum:
{
Due: No description available. ,
OverDue: No description available. ,
Paid: No description available. ,
Void: No description available. ,
}
,
Required: False ,
}
enum ,
amountDue:
{
Description: The amount due as of now. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
azurePrepaymentApplied:
{
Description: The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billedAmount:
{
Description: The total charges for the invoice billing period. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
creditAmount:
{
Description: 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. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
freeAzureCreditApplied:
{
Description: The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
subTotal:
{
Description: The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
taxAmount:
{
Description: The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
totalAmount:
{
Description: The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
invoicePeriodStartDate:
{
Description: The start date of the billing period for which the invoice is generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end date of the billing period for which the invoice is generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceType:
{
Description: Invoice type. ,
Enum:
{
AzureService: No description available. ,
AzureMarketplace: No description available. ,
AzureSupport: No description available. ,
}
,
Required: False ,
}
enum ,
isMonthlyInvoice:
{
Description: Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
boolean ,
billingProfileId:
{
Description: The ID of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
purchaseOrderNumber:
{
Description: An optional purchase order number for the invoice. ,
Required: False ,
}
string ,
documents:
{
Description: List of documents available to download such as invoice and tax receipt. ,
Required: False ,
}
[
{
kind:
{
Description: The type of the document. ,
Enum:
{
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: Document URL. ,
Required: False ,
}
string ,
documentNumbers:
{
Description: Document numbers for an Enterprise Agreement invoice. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
payments:
{
Description: List of payments. ,
Required: False ,
}
[
{
paymentType:
{
Description: The type of payment. ,
Required: False ,
}
string ,
amount:
{
Description: The paid amount. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
date:
{
Description: The date when the payment was made. ,
Format: date-time ,
Required: False ,
}
string ,
paymentMethodFamily:
{
Description: The family of payment method. ,
Enum:
{
Credits: No description available. ,
CheckWire: No description available. ,
CreditCard: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
}
,
]
,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
Required: False ,
}
string ,
rebillDetails:
{
Description: Rebill details of an Enterprise Agreement invoice. ,
Required: False ,
}
{
rebillDocumentType:
{
Description: The type of the document generated when an Enterprise Agreement invoice is rebilled. ,
Enum:
{
Credit: No description available. ,
Rebill: No description available. ,
Original: No description available. ,
}
,
Required: False ,
}
enum ,
rebilledInvoiceId:
{
Description: The ID of the invoice generated when an Enterprise Agreement invoice is rebilled. ,
Required: False ,
}
string ,
latestInvoiceId:
{
Description: The ID of the latest invoice generated when an Enterprise Agreement invoice is rebilled. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Invoices_DownloadMultipleBillingProfileInvoices (removed)
Description :  Gets a URL to download multiple invoice documents (invoice pdf, tax receipts, credit notes) as a zip file.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/downloadDocuments
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
downloadUrls:
{
Description: An array of download urls for individual documents. The download url paths in the request body should match the path of the original request. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: GET this URL to retrieve the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
string ,
}

⚐ Response (200)

{
expiryTime:
{
Description: The time in UTC when the download URL will expire. ,
Format: date-time ,
Required: False ,
}
string ,
url:
{
Description: The URL to the PDF file. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Invoices_Get (removed)
Description :  Gets an invoice by ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices/{invoiceName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceName:
{
Description: The ID that uniquely identifies an invoice. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: An invoice. ,
Required: False ,
}
{
dueDate:
{
Description: The due date for the invoice. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceDate:
{
Description: The date when the invoice was generated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the invoice. ,
Enum:
{
Due: No description available. ,
OverDue: No description available. ,
Paid: No description available. ,
Void: No description available. ,
}
,
Required: False ,
}
enum ,
amountDue:
{
Description: The amount due as of now. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
azurePrepaymentApplied:
{
Description: The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billedAmount:
{
Description: The total charges for the invoice billing period. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
creditAmount:
{
Description: 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. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
freeAzureCreditApplied:
{
Description: The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
subTotal:
{
Description: The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
taxAmount:
{
Description: The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
totalAmount:
{
Description: The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
invoicePeriodStartDate:
{
Description: The start date of the billing period for which the invoice is generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end date of the billing period for which the invoice is generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceType:
{
Description: Invoice type. ,
Enum:
{
AzureService: No description available. ,
AzureMarketplace: No description available. ,
AzureSupport: No description available. ,
}
,
Required: False ,
}
enum ,
isMonthlyInvoice:
{
Description: Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
boolean ,
billingProfileId:
{
Description: The ID of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
purchaseOrderNumber:
{
Description: An optional purchase order number for the invoice. ,
Required: False ,
}
string ,
documents:
{
Description: List of documents available to download such as invoice and tax receipt. ,
Required: False ,
}
[
{
kind:
{
Description: The type of the document. ,
Enum:
{
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: Document URL. ,
Required: False ,
}
string ,
documentNumbers:
{
Description: Document numbers for an Enterprise Agreement invoice. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
payments:
{
Description: List of payments. ,
Required: False ,
}
[
{
paymentType:
{
Description: The type of payment. ,
Required: False ,
}
string ,
amount:
{
Description: The paid amount. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
date:
{
Description: The date when the payment was made. ,
Format: date-time ,
Required: False ,
}
string ,
paymentMethodFamily:
{
Description: The family of payment method. ,
Enum:
{
Credits: No description available. ,
CheckWire: No description available. ,
CreditCard: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
}
,
]
,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
Required: False ,
}
string ,
rebillDetails:
{
Description: Rebill details of an Enterprise Agreement invoice. ,
Required: False ,
}
{
rebillDocumentType:
{
Description: The type of the document generated when an Enterprise Agreement invoice is rebilled. ,
Enum:
{
Credit: No description available. ,
Rebill: No description available. ,
Original: No description available. ,
}
,
Required: False ,
}
enum ,
rebilledInvoiceId:
{
Description: The ID of the invoice generated when an Enterprise Agreement invoice is rebilled. ,
Required: False ,
}
string ,
latestInvoiceId:
{
Description: The ID of the latest invoice generated when an Enterprise Agreement invoice is rebilled. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingSubscriptions_ListByBillingAccount (removed)
Description :  Lists the subscriptions for a billing account. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing subscriptions. ,
Required: False ,
}
[
{
properties:
{
Description: The billing properties of a subscription. ,
Required: False ,
}
{
displayName:
{
Description: The name of the subscription. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription. ,
Format: uuid ,
Required: False ,
}
string ,
subscriptionBillingStatus:
{
Description: The current billing status of the subscription. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
Abandoned: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
lastMonthCharges:
{
Description: The last month charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billingProfileId:
{
Description: The ID of the billing profile to which the subscription is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the subscription is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the subscription is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the subscription is billed. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this subscription. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The sku ID of the Azure plan for the subscription. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the Azure plan for the subscription. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Invoices_ListByBillingSubscription (removed)
Description :  Lists the invoices for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}/invoices
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: The ID that uniquely identifies a subscription. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: Invoice period start date. ,
Required: True ,
}
string ,
periodEndDate:
{
Description: Invoice period end date. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of invoices. ,
Required: False ,
}
[
{
properties:
{
Description: An invoice. ,
Required: False ,
}
{
dueDate:
{
Description: The due date for the invoice. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceDate:
{
Description: The date when the invoice was generated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the invoice. ,
Enum:
{
Due: No description available. ,
OverDue: No description available. ,
Paid: No description available. ,
Void: No description available. ,
}
,
Required: False ,
}
enum ,
amountDue:
{
Description: The amount due as of now. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
azurePrepaymentApplied:
{
Description: The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billedAmount:
{
Description: The total charges for the invoice billing period. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
creditAmount:
{
Description: 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. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
freeAzureCreditApplied:
{
Description: The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
subTotal:
{
Description: The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
taxAmount:
{
Description: The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
totalAmount:
{
Description: The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
invoicePeriodStartDate:
{
Description: The start date of the billing period for which the invoice is generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end date of the billing period for which the invoice is generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceType:
{
Description: Invoice type. ,
Enum:
{
AzureService: No description available. ,
AzureMarketplace: No description available. ,
AzureSupport: No description available. ,
}
,
Required: False ,
}
enum ,
isMonthlyInvoice:
{
Description: Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
boolean ,
billingProfileId:
{
Description: The ID of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
purchaseOrderNumber:
{
Description: An optional purchase order number for the invoice. ,
Required: False ,
}
string ,
documents:
{
Description: List of documents available to download such as invoice and tax receipt. ,
Required: False ,
}
[
{
kind:
{
Description: The type of the document. ,
Enum:
{
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: Document URL. ,
Required: False ,
}
string ,
documentNumbers:
{
Description: Document numbers for an Enterprise Agreement invoice. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
payments:
{
Description: List of payments. ,
Required: False ,
}
[
{
paymentType:
{
Description: The type of payment. ,
Required: False ,
}
string ,
amount:
{
Description: The paid amount. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
date:
{
Description: The date when the payment was made. ,
Format: date-time ,
Required: False ,
}
string ,
paymentMethodFamily:
{
Description: The family of payment method. ,
Enum:
{
Credits: No description available. ,
CheckWire: No description available. ,
CreditCard: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
}
,
]
,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
Required: False ,
}
string ,
rebillDetails:
{
Description: Rebill details of an Enterprise Agreement invoice. ,
Required: False ,
}
{
rebillDocumentType:
{
Description: The type of the document generated when an Enterprise Agreement invoice is rebilled. ,
Enum:
{
Credit: No description available. ,
Rebill: No description available. ,
Original: No description available. ,
}
,
Required: False ,
}
enum ,
rebilledInvoiceId:
{
Description: The ID of the invoice generated when an Enterprise Agreement invoice is rebilled. ,
Required: False ,
}
string ,
latestInvoiceId:
{
Description: The ID of the latest invoice generated when an Enterprise Agreement invoice is rebilled. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Invoices_GetById (removed)
Description :  Gets an invoice by ID.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{billingSubscriptionName}/invoices/{invoiceName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: The ID that uniquely identifies a subscription. ,
Required: True ,
}
string ,
invoiceName:
{
Description: The ID that uniquely identifies an invoice. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: An invoice. ,
Required: False ,
}
{
dueDate:
{
Description: The due date for the invoice. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceDate:
{
Description: The date when the invoice was generated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of the invoice. ,
Enum:
{
Due: No description available. ,
OverDue: No description available. ,
Paid: No description available. ,
Void: No description available. ,
}
,
Required: False ,
}
enum ,
amountDue:
{
Description: The amount due as of now. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
azurePrepaymentApplied:
{
Description: The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billedAmount:
{
Description: The total charges for the invoice billing period. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
creditAmount:
{
Description: 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. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
freeAzureCreditApplied:
{
Description: The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
subTotal:
{
Description: The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
taxAmount:
{
Description: The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
totalAmount:
{
Description: The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
invoicePeriodStartDate:
{
Description: The start date of the billing period for which the invoice is generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end date of the billing period for which the invoice is generated. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceType:
{
Description: Invoice type. ,
Enum:
{
AzureService: No description available. ,
AzureMarketplace: No description available. ,
AzureSupport: No description available. ,
}
,
Required: False ,
}
enum ,
isMonthlyInvoice:
{
Description: Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement. ,
Required: False ,
}
boolean ,
billingProfileId:
{
Description: The ID of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile for which the invoice is generated. ,
Required: False ,
}
string ,
purchaseOrderNumber:
{
Description: An optional purchase order number for the invoice. ,
Required: False ,
}
string ,
documents:
{
Description: List of documents available to download such as invoice and tax receipt. ,
Required: False ,
}
[
{
kind:
{
Description: The type of the document. ,
Enum:
{
Invoice: No description available. ,
VoidNote: No description available. ,
TaxReceipt: No description available. ,
CreditNote: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: Document URL. ,
Required: False ,
}
string ,
documentNumbers:
{
Description: Document numbers for an Enterprise Agreement invoice. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
payments:
{
Description: List of payments. ,
Required: False ,
}
[
{
paymentType:
{
Description: The type of payment. ,
Required: False ,
}
string ,
amount:
{
Description: The paid amount. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
date:
{
Description: The date when the payment was made. ,
Format: date-time ,
Required: False ,
}
string ,
paymentMethodFamily:
{
Description: The family of payment method. ,
Enum:
{
Credits: No description available. ,
CheckWire: No description available. ,
CreditCard: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
paymentMethodType:
{
Description: The type of payment method. ,
Required: False ,
}
string ,
}
,
]
,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
Required: False ,
}
string ,
rebillDetails:
{
Description: Rebill details of an Enterprise Agreement invoice. ,
Required: False ,
}
{
rebillDocumentType:
{
Description: The type of the document generated when an Enterprise Agreement invoice is rebilled. ,
Enum:
{
Credit: No description available. ,
Rebill: No description available. ,
Original: No description available. ,
}
,
Required: False ,
}
enum ,
rebilledInvoiceId:
{
Description: The ID of the invoice generated when an Enterprise Agreement invoice is rebilled. ,
Required: False ,
}
string ,
latestInvoiceId:
{
Description: The ID of the latest invoice generated when an Enterprise Agreement invoice is rebilled. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingSubscriptions_ListByBillingProfile (removed)
Description :  Lists the subscriptions that are billed to a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingSubscriptions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing subscriptions. ,
Required: False ,
}
[
{
properties:
{
Description: The billing properties of a subscription. ,
Required: False ,
}
{
displayName:
{
Description: The name of the subscription. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription. ,
Format: uuid ,
Required: False ,
}
string ,
subscriptionBillingStatus:
{
Description: The current billing status of the subscription. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
Abandoned: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
lastMonthCharges:
{
Description: The last month charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billingProfileId:
{
Description: The ID of the billing profile to which the subscription is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the subscription is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the subscription is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the subscription is billed. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this subscription. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The sku ID of the Azure plan for the subscription. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the Azure plan for the subscription. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingSubscriptions_ListByInvoiceSection (removed)
Description :  Lists the subscriptions that are billed to an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingSubscriptions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing subscriptions. ,
Required: False ,
}
[
{
properties:
{
Description: The billing properties of a subscription. ,
Required: False ,
}
{
displayName:
{
Description: The name of the subscription. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription. ,
Format: uuid ,
Required: False ,
}
string ,
subscriptionBillingStatus:
{
Description: The current billing status of the subscription. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
Abandoned: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
lastMonthCharges:
{
Description: The last month charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billingProfileId:
{
Description: The ID of the billing profile to which the subscription is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the subscription is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the subscription is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the subscription is billed. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this subscription. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The sku ID of the Azure plan for the subscription. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the Azure plan for the subscription. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingSubscriptions_Get (removed)
Description :  Gets a subscription by its ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingSubscriptions/{billingSubscriptionName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: The ID that uniquely identifies a subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The billing properties of a subscription. ,
Required: False ,
}
{
displayName:
{
Description: The name of the subscription. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription. ,
Format: uuid ,
Required: False ,
}
string ,
subscriptionBillingStatus:
{
Description: The current billing status of the subscription. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
Abandoned: No description available. ,
Deleted: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
lastMonthCharges:
{
Description: The last month charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
monthToDateCharges:
{
Description: The current month to date charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billingProfileId:
{
Description: The ID of the billing profile to which the subscription is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the subscription is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the subscription is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the subscription is billed. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this subscription. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
skuId:
{
Description: The sku ID of the Azure plan for the subscription. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the Azure plan for the subscription. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingSubscriptions_Transfer (removed)
Description :  Moves a subscription's charges to a new invoice section. The new invoice section must belong to the same billing profile as the existing invoice section. This operation is supported only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingSubscriptions/{billingSubscriptionName}/transfer
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: The ID that uniquely identifies a subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the transfer product operation. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: False ,
}
string ,
destinationBillingProfileId:
{
Description: The destination billing profile id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the transfer billing subscription operation result. ,
Required: False ,
}
{
billingSubscriptionName:
{
Description: The destination billing subscription id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result. ,
}
string ,
retry-after:
{
Description: Recommended time to wait before making another request to check the status of the operation. The time is specified in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingSubscriptions_ValidateTransfer (removed)
Description :  Validates if a subscription's charges can be moved to a new invoice section. This operation is supported only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingSubscriptions/{billingSubscriptionName}/validateTransferEligibility
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: The ID that uniquely identifies a subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the validate transfer eligibility operation. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: False ,
}
string ,
destinationBillingProfileId:
{
Description: The destination billing profile id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
isTransferEligible:
{
Description: Specifies whether the subscription is eligible to be transferred. ,
Required: False ,
}
boolean ,
errorDetails:
{
Description: Validation error details. ,
Required: False ,
}
{
code:
{
Description: Error code for the product transfer validation. ,
Enum:
{
BillingAccountInactive: No description available. ,
CrossBillingAccountNotAllowed: No description available. ,
DestinationBillingProfileInactive: No description available. ,
DestinationBillingProfileNotFound: No description available. ,
DestinationBillingProfilePastDue: No description available. ,
DestinationInvoiceSectionInactive: No description available. ,
DestinationInvoiceSectionNotFound: No description available. ,
InsufficientPermissionOnDestination: No description available. ,
InsufficientPermissionOnSource: No description available. ,
InvalidDestination: No description available. ,
InvalidSource: No description available. ,
MarketplaceNotEnabledOnDestination: No description available. ,
NotAvailableForDestinationMarket: No description available. ,
ProductInactive: No description available. ,
ProductNotFound: No description available. ,
ProductTypeNotSupported: No description available. ,
SourceBillingProfilePastDue: No description available. ,
SourceInvoiceSectionInactive: No description available. ,
SubscriptionNotActive: No description available. ,
SubscriptionTypeNotSupported: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: Detailed error message explaining the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Products_ListByBillingAccount (removed)
Description :  Lists the products for a billing account. These don't include products billed based on usage. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter by product type. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value are separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of products. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a product. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date when the product was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the type of product. ,
Required: False ,
}
string ,
productType:
{
Description: The description of the type of product. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the product. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
PastDue: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
Disabled: No description available. ,
Cancelled: No description available. ,
AutoRenew: No description available. ,
}
,
Required: False ,
}
enum ,
endDate:
{
Description: The date when the product will be renewed or canceled. ,
Format: date-time ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The frequency at which the product will be billed. ,
Enum:
{
OneTime: No description available. ,
Monthly: No description available. ,
UsageBased: No description available. ,
}
,
Required: False ,
}
enum ,
lastCharge:
{
Description: The last month charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
lastChargeDate:
{
Description: The date of the last charge. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased for the product. ,
Required: False ,
}
number ,
skuId:
{
Description: The sku ID of the product. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the product. ,
Required: False ,
}
string ,
tenantId:
{
Description: The id of the tenant in which the product is used. ,
Required: False ,
}
string ,
availabilityId:
{
Description: The availability of the product. ,
Required: False ,
}
string ,
parentProductId:
{
Description: Parent product Id. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this product. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Products_ListByInvoiceSection (removed)
Description :  Lists the products for an invoice section. These don't include products billed based on usage. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/products
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter by product type. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value are separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of products. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a product. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date when the product was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the type of product. ,
Required: False ,
}
string ,
productType:
{
Description: The description of the type of product. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the product. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
PastDue: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
Disabled: No description available. ,
Cancelled: No description available. ,
AutoRenew: No description available. ,
}
,
Required: False ,
}
enum ,
endDate:
{
Description: The date when the product will be renewed or canceled. ,
Format: date-time ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The frequency at which the product will be billed. ,
Enum:
{
OneTime: No description available. ,
Monthly: No description available. ,
UsageBased: No description available. ,
}
,
Required: False ,
}
enum ,
lastCharge:
{
Description: The last month charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
lastChargeDate:
{
Description: The date of the last charge. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased for the product. ,
Required: False ,
}
number ,
skuId:
{
Description: The sku ID of the product. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the product. ,
Required: False ,
}
string ,
tenantId:
{
Description: The id of the tenant in which the product is used. ,
Required: False ,
}
string ,
availabilityId:
{
Description: The availability of the product. ,
Required: False ,
}
string ,
parentProductId:
{
Description: Parent product Id. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this product. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Products_Get (removed)
Description :  Gets a product by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/products/{productName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
productName:
{
Description: The ID that uniquely identifies a product. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a product. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date when the product was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the type of product. ,
Required: False ,
}
string ,
productType:
{
Description: The description of the type of product. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the product. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
PastDue: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
Disabled: No description available. ,
Cancelled: No description available. ,
AutoRenew: No description available. ,
}
,
Required: False ,
}
enum ,
endDate:
{
Description: The date when the product will be renewed or canceled. ,
Format: date-time ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The frequency at which the product will be billed. ,
Enum:
{
OneTime: No description available. ,
Monthly: No description available. ,
UsageBased: No description available. ,
}
,
Required: False ,
}
enum ,
lastCharge:
{
Description: The last month charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
lastChargeDate:
{
Description: The date of the last charge. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased for the product. ,
Required: False ,
}
number ,
skuId:
{
Description: The sku ID of the product. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the product. ,
Required: False ,
}
string ,
tenantId:
{
Description: The id of the tenant in which the product is used. ,
Required: False ,
}
string ,
availabilityId:
{
Description: The availability of the product. ,
Required: False ,
}
string ,
parentProductId:
{
Description: Parent product Id. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this product. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Products_Transfer (removed)
Description :  Moves a product's charges to a new invoice section. The new invoice section must belong to the same billing profile as the existing invoice section. This operation is supported only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/products/{productName}/transfer
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
productName:
{
Description: The ID that uniquely identifies a product. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the transfer product operation. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: False ,
}
string ,
destinationBillingProfileId:
{
Description: The destination billing profile id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a product. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date when the product was purchased. ,
Format: date-time ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the type of product. ,
Required: False ,
}
string ,
productType:
{
Description: The description of the type of product. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the product. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
PastDue: No description available. ,
Expiring: No description available. ,
Expired: No description available. ,
Disabled: No description available. ,
Cancelled: No description available. ,
AutoRenew: No description available. ,
}
,
Required: False ,
}
enum ,
endDate:
{
Description: The date when the product will be renewed or canceled. ,
Format: date-time ,
Required: False ,
}
string ,
billingFrequency:
{
Description: The frequency at which the product will be billed. ,
Enum:
{
OneTime: No description available. ,
Monthly: No description available. ,
UsageBased: No description available. ,
}
,
Required: False ,
}
enum ,
lastCharge:
{
Description: The last month charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
lastChargeDate:
{
Description: The date of the last charge. ,
Format: date-time ,
Required: False ,
}
string ,
quantity:
{
Description: The quantity purchased for the product. ,
Required: False ,
}
number ,
skuId:
{
Description: The sku ID of the product. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the product. ,
Required: False ,
}
string ,
tenantId:
{
Description: The id of the tenant in which the product is used. ,
Required: False ,
}
string ,
availabilityId:
{
Description: The availability of the product. ,
Required: False ,
}
string ,
parentProductId:
{
Description: Parent product Id. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the product is billed. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the product is billed. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this product. ,
Required: False ,
}
{
resellerId:
{
Description: The MPN ID of the reseller. ,
Required: False ,
}
string ,
description:
{
Description: The name of the reseller. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result ,
}
string ,
retry-after:
{
Description: Recommended time to wait before making another request to check the status of the operation. The time is specified in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Products_ValidateTransfer (removed)
Description :  Validates if a product's charges can be moved to a new invoice section. This operation is supported only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/products/{productName}/validateTransferEligibility
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
productName:
{
Description: The ID that uniquely identifies a product. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the validate transfer eligibility operation. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: False ,
}
string ,
destinationBillingProfileId:
{
Description: The destination billing profile id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
isTransferEligible:
{
Description: Specifies whether the transfer is eligible or not. ,
Required: False ,
}
boolean ,
errorDetails:
{
Description: Validation error details. ,
Required: False ,
}
{
code:
{
Description: Error code for the product transfer validation. ,
Enum:
{
InvalidSource: No description available. ,
ProductNotActive: No description available. ,
InsufficientPermissionOnSource: No description available. ,
InsufficientPermissionOnDestination: No description available. ,
DestinationBillingProfilePastDue: No description available. ,
ProductTypeNotSupported: No description available. ,
CrossBillingAccountNotAllowed: No description available. ,
NotAvailableForDestinationMarket: No description available. ,
OneTimePurchaseProductTransferNotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: Detailed error message explaining the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Transactions_ListByBillingAccount (removed)
Description :  Lists the billed and unbilled transactions by billing account name for given start and end date. Transactions include purchases, refunds and Azure usage charges. Unbilled transactions are listed under pending invoice ID and do not include tax. Tax is added to the amount once an invoice is generated.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/transactions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Required: True ,
}
string ,
periodEndDate:
{
Description: The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter by transaction type. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value are separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of transactions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a transaction. ,
Required: False ,
}
{
kind:
{
Description: The kind of transaction. Options are all or reservation. ,
Enum:
{
all: No description available. ,
reservation: No description available. ,
}
,
Required: False ,
}
enum ,
date:
{
Description: The date of transaction. ,
Format: date-time ,
Required: False ,
}
string ,
invoice:
{
Description: Invoice on which the transaction was billed or 'pending' if the transaction is not billed. ,
Required: False ,
}
string ,
orderId:
{
Description: The order ID of the reservation. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
orderName:
{
Description: The name of the reservation order. The field is only applicable for transactions of kind reservation. ,
Required: False ,
}
string ,
productFamily:
{
Description: The family of the product for which the transaction took place. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product type for which the transaction took place. ,
Required: False ,
}
string ,
productType:
{
Description: The type of the product for which the transaction took place. ,
Required: False ,
}
string ,
productDescription:
{
Description: The description of the product for which the transaction took place. ,
Required: False ,
}
string ,
transactionType:
{
Description: The type of transaction. ,
Enum:
{
Purchase: No description available. ,
Usage Charge: No description available. ,
}
,
Required: False ,
}
enum ,
transactionAmount:
{
Description: The charge associated with the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
quantity:
{
Description: The quantity purchased in the transaction. ,
Format: int32 ,
Required: False ,
}
integer ,
invoiceSectionId:
{
Description: The ID of the invoice section which will be billed for the transaction. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section which will be billed for the transaction. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile which will be billed for the transaction. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile which will be billed for the transaction. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The name of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
azureCreditApplied:
{
Description: The amount of any Azure credits automatically applied to this transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billingCurrency:
{
Description: The ISO 4217 code for the currency in which this transaction is billed. ,
Required: False ,
}
string ,
discount:
{
Description: The percentage discount, if any, applied to this transaction. ,
Required: False ,
}
number ,
effectivePrice:
{
Description: The price of the product after applying any discounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
exchangeRate:
{
Description: The exchange rate used to convert charged amount to billing currency, if applicable. ,
Required: False ,
}
number ,
marketPrice:
{
Description: The retail price of the product. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
pricingCurrency:
{
Description: The ISO 4217 code for the currency in which the product is priced. ,
Required: False ,
}
string ,
servicePeriodStartDate:
{
Description: The date of the purchase of the product, or the start date of the month in which usage started. ,
Format: date-time ,
Required: False ,
}
string ,
servicePeriodEndDate:
{
Description: The end date of the product term, or the end date of the month in which usage ended. ,
Format: date-time ,
Required: False ,
}
string ,
subTotal:
{
Description: The pre-tax charged amount for the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
tax:
{
Description: The tax amount applied to the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
unitOfMeasure:
{
Description: The unit of measure used to bill for the product. For example, compute services are billed per hour. ,
Required: False ,
}
string ,
units:
{
Description: The number of units used for a given product. ,
Required: False ,
}
number ,
unitType:
{
Description: The description for the unit of measure for a given product. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Transactions_ListByBillingProfile (removed)
Description :  Lists the billed and unbilled transactions by billing profile name for given start date and end date. Transactions include purchases, refunds and Azure usage charges. Unbilled transactions are listed under pending invoice Id and do not include tax. Tax is added to the amount once an invoice is generated.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/transactions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Required: True ,
}
string ,
periodEndDate:
{
Description: The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter by transaction type. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value are separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of transactions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a transaction. ,
Required: False ,
}
{
kind:
{
Description: The kind of transaction. Options are all or reservation. ,
Enum:
{
all: No description available. ,
reservation: No description available. ,
}
,
Required: False ,
}
enum ,
date:
{
Description: The date of transaction. ,
Format: date-time ,
Required: False ,
}
string ,
invoice:
{
Description: Invoice on which the transaction was billed or 'pending' if the transaction is not billed. ,
Required: False ,
}
string ,
orderId:
{
Description: The order ID of the reservation. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
orderName:
{
Description: The name of the reservation order. The field is only applicable for transactions of kind reservation. ,
Required: False ,
}
string ,
productFamily:
{
Description: The family of the product for which the transaction took place. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product type for which the transaction took place. ,
Required: False ,
}
string ,
productType:
{
Description: The type of the product for which the transaction took place. ,
Required: False ,
}
string ,
productDescription:
{
Description: The description of the product for which the transaction took place. ,
Required: False ,
}
string ,
transactionType:
{
Description: The type of transaction. ,
Enum:
{
Purchase: No description available. ,
Usage Charge: No description available. ,
}
,
Required: False ,
}
enum ,
transactionAmount:
{
Description: The charge associated with the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
quantity:
{
Description: The quantity purchased in the transaction. ,
Format: int32 ,
Required: False ,
}
integer ,
invoiceSectionId:
{
Description: The ID of the invoice section which will be billed for the transaction. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section which will be billed for the transaction. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile which will be billed for the transaction. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile which will be billed for the transaction. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The name of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
azureCreditApplied:
{
Description: The amount of any Azure credits automatically applied to this transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billingCurrency:
{
Description: The ISO 4217 code for the currency in which this transaction is billed. ,
Required: False ,
}
string ,
discount:
{
Description: The percentage discount, if any, applied to this transaction. ,
Required: False ,
}
number ,
effectivePrice:
{
Description: The price of the product after applying any discounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
exchangeRate:
{
Description: The exchange rate used to convert charged amount to billing currency, if applicable. ,
Required: False ,
}
number ,
marketPrice:
{
Description: The retail price of the product. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
pricingCurrency:
{
Description: The ISO 4217 code for the currency in which the product is priced. ,
Required: False ,
}
string ,
servicePeriodStartDate:
{
Description: The date of the purchase of the product, or the start date of the month in which usage started. ,
Format: date-time ,
Required: False ,
}
string ,
servicePeriodEndDate:
{
Description: The end date of the product term, or the end date of the month in which usage ended. ,
Format: date-time ,
Required: False ,
}
string ,
subTotal:
{
Description: The pre-tax charged amount for the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
tax:
{
Description: The tax amount applied to the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
unitOfMeasure:
{
Description: The unit of measure used to bill for the product. For example, compute services are billed per hour. ,
Required: False ,
}
string ,
units:
{
Description: The number of units used for a given product. ,
Required: False ,
}
number ,
unitType:
{
Description: The description for the unit of measure for a given product. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Transactions_ListByInvoiceSection (removed)
Description :  Lists the billed and unbilled transactions by invoice section name for given start date and end date. Transactions include purchases, refunds and Azure usage charges. Unbilled transactions are listed under pending invoice Id and do not include tax. Tax is added to the amount once an invoice is generated.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/transactions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Required: True ,
}
string ,
periodEndDate:
{
Description: The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter by transaction type. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value are separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of transactions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a transaction. ,
Required: False ,
}
{
kind:
{
Description: The kind of transaction. Options are all or reservation. ,
Enum:
{
all: No description available. ,
reservation: No description available. ,
}
,
Required: False ,
}
enum ,
date:
{
Description: The date of transaction. ,
Format: date-time ,
Required: False ,
}
string ,
invoice:
{
Description: Invoice on which the transaction was billed or 'pending' if the transaction is not billed. ,
Required: False ,
}
string ,
orderId:
{
Description: The order ID of the reservation. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
orderName:
{
Description: The name of the reservation order. The field is only applicable for transactions of kind reservation. ,
Required: False ,
}
string ,
productFamily:
{
Description: The family of the product for which the transaction took place. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product type for which the transaction took place. ,
Required: False ,
}
string ,
productType:
{
Description: The type of the product for which the transaction took place. ,
Required: False ,
}
string ,
productDescription:
{
Description: The description of the product for which the transaction took place. ,
Required: False ,
}
string ,
transactionType:
{
Description: The type of transaction. ,
Enum:
{
Purchase: No description available. ,
Usage Charge: No description available. ,
}
,
Required: False ,
}
enum ,
transactionAmount:
{
Description: The charge associated with the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
quantity:
{
Description: The quantity purchased in the transaction. ,
Format: int32 ,
Required: False ,
}
integer ,
invoiceSectionId:
{
Description: The ID of the invoice section which will be billed for the transaction. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section which will be billed for the transaction. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile which will be billed for the transaction. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile which will be billed for the transaction. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The name of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
azureCreditApplied:
{
Description: The amount of any Azure credits automatically applied to this transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billingCurrency:
{
Description: The ISO 4217 code for the currency in which this transaction is billed. ,
Required: False ,
}
string ,
discount:
{
Description: The percentage discount, if any, applied to this transaction. ,
Required: False ,
}
number ,
effectivePrice:
{
Description: The price of the product after applying any discounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
exchangeRate:
{
Description: The exchange rate used to convert charged amount to billing currency, if applicable. ,
Required: False ,
}
number ,
marketPrice:
{
Description: The retail price of the product. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
pricingCurrency:
{
Description: The ISO 4217 code for the currency in which the product is priced. ,
Required: False ,
}
string ,
servicePeriodStartDate:
{
Description: The date of the purchase of the product, or the start date of the month in which usage started. ,
Format: date-time ,
Required: False ,
}
string ,
servicePeriodEndDate:
{
Description: The end date of the product term, or the end date of the month in which usage ended. ,
Format: date-time ,
Required: False ,
}
string ,
subTotal:
{
Description: The pre-tax charged amount for the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
tax:
{
Description: The tax amount applied to the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
unitOfMeasure:
{
Description: The unit of measure used to bill for the product. For example, compute services are billed per hour. ,
Required: False ,
}
string ,
units:
{
Description: The number of units used for a given product. ,
Required: False ,
}
number ,
unitType:
{
Description: The description for the unit of measure for a given product. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Transactions_ListByInvoice (removed)
Description :  Lists the transactions for an invoice. Transactions include purchases, refunds and Azure usage charges.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices/{invoiceName}/transactions
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceName:
{
Description: The ID that uniquely identifies an invoice. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of transactions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a transaction. ,
Required: False ,
}
{
kind:
{
Description: The kind of transaction. Options are all or reservation. ,
Enum:
{
all: No description available. ,
reservation: No description available. ,
}
,
Required: False ,
}
enum ,
date:
{
Description: The date of transaction. ,
Format: date-time ,
Required: False ,
}
string ,
invoice:
{
Description: Invoice on which the transaction was billed or 'pending' if the transaction is not billed. ,
Required: False ,
}
string ,
orderId:
{
Description: The order ID of the reservation. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
orderName:
{
Description: The name of the reservation order. The field is only applicable for transactions of kind reservation. ,
Required: False ,
}
string ,
productFamily:
{
Description: The family of the product for which the transaction took place. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product type for which the transaction took place. ,
Required: False ,
}
string ,
productType:
{
Description: The type of the product for which the transaction took place. ,
Required: False ,
}
string ,
productDescription:
{
Description: The description of the product for which the transaction took place. ,
Required: False ,
}
string ,
transactionType:
{
Description: The type of transaction. ,
Enum:
{
Purchase: No description available. ,
Usage Charge: No description available. ,
}
,
Required: False ,
}
enum ,
transactionAmount:
{
Description: The charge associated with the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
quantity:
{
Description: The quantity purchased in the transaction. ,
Format: int32 ,
Required: False ,
}
integer ,
invoiceSectionId:
{
Description: The ID of the invoice section which will be billed for the transaction. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section which will be billed for the transaction. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile which will be billed for the transaction. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile which will be billed for the transaction. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The name of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
azureCreditApplied:
{
Description: The amount of any Azure credits automatically applied to this transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billingCurrency:
{
Description: The ISO 4217 code for the currency in which this transaction is billed. ,
Required: False ,
}
string ,
discount:
{
Description: The percentage discount, if any, applied to this transaction. ,
Required: False ,
}
number ,
effectivePrice:
{
Description: The price of the product after applying any discounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
exchangeRate:
{
Description: The exchange rate used to convert charged amount to billing currency, if applicable. ,
Required: False ,
}
number ,
marketPrice:
{
Description: The retail price of the product. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
pricingCurrency:
{
Description: The ISO 4217 code for the currency in which the product is priced. ,
Required: False ,
}
string ,
servicePeriodStartDate:
{
Description: The date of the purchase of the product, or the start date of the month in which usage started. ,
Format: date-time ,
Required: False ,
}
string ,
servicePeriodEndDate:
{
Description: The end date of the product term, or the end date of the month in which usage ended. ,
Format: date-time ,
Required: False ,
}
string ,
subTotal:
{
Description: The pre-tax charged amount for the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
tax:
{
Description: The tax amount applied to the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
unitOfMeasure:
{
Description: The unit of measure used to bill for the product. For example, compute services are billed per hour. ,
Required: False ,
}
string ,
units:
{
Description: The number of units used for a given product. ,
Required: False ,
}
number ,
unitType:
{
Description: The description for the unit of measure for a given product. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Transactions_Get (removed)
Description :  Gets a transaction by ID. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/transactions/{transactionName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
transactionName:
{
Description: The ID that uniquely identifies a transaction. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: The start date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Required: True ,
}
string ,
periodEndDate:
{
Description: The end date to fetch the transactions. The date should be specified in MM-DD-YYYY format. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a transaction. ,
Required: False ,
}
{
kind:
{
Description: The kind of transaction. Options are all or reservation. ,
Enum:
{
all: No description available. ,
reservation: No description available. ,
}
,
Required: False ,
}
enum ,
date:
{
Description: The date of transaction. ,
Format: date-time ,
Required: False ,
}
string ,
invoice:
{
Description: Invoice on which the transaction was billed or 'pending' if the transaction is not billed. ,
Required: False ,
}
string ,
orderId:
{
Description: The order ID of the reservation. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
orderName:
{
Description: The name of the reservation order. The field is only applicable for transactions of kind reservation. ,
Required: False ,
}
string ,
productFamily:
{
Description: The family of the product for which the transaction took place. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The ID of the product type for which the transaction took place. ,
Required: False ,
}
string ,
productType:
{
Description: The type of the product for which the transaction took place. ,
Required: False ,
}
string ,
productDescription:
{
Description: The description of the product for which the transaction took place. ,
Required: False ,
}
string ,
transactionType:
{
Description: The type of transaction. ,
Enum:
{
Purchase: No description available. ,
Usage Charge: No description available. ,
}
,
Required: False ,
}
enum ,
transactionAmount:
{
Description: The charge associated with the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
quantity:
{
Description: The quantity purchased in the transaction. ,
Format: int32 ,
Required: False ,
}
integer ,
invoiceSectionId:
{
Description: The ID of the invoice section which will be billed for the transaction. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section which will be billed for the transaction. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile which will be billed for the transaction. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile which will be billed for the transaction. ,
Required: False ,
}
string ,
customerId:
{
Description: The ID of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: The name of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The name of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation. ,
Required: False ,
}
string ,
azureCreditApplied:
{
Description: The amount of any Azure credits automatically applied to this transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billingCurrency:
{
Description: The ISO 4217 code for the currency in which this transaction is billed. ,
Required: False ,
}
string ,
discount:
{
Description: The percentage discount, if any, applied to this transaction. ,
Required: False ,
}
number ,
effectivePrice:
{
Description: The price of the product after applying any discounts. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
exchangeRate:
{
Description: The exchange rate used to convert charged amount to billing currency, if applicable. ,
Required: False ,
}
number ,
marketPrice:
{
Description: The retail price of the product. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
pricingCurrency:
{
Description: The ISO 4217 code for the currency in which the product is priced. ,
Required: False ,
}
string ,
servicePeriodStartDate:
{
Description: The date of the purchase of the product, or the start date of the month in which usage started. ,
Format: date-time ,
Required: False ,
}
string ,
servicePeriodEndDate:
{
Description: The end date of the product term, or the end date of the month in which usage ended. ,
Format: date-time ,
Required: False ,
}
string ,
subTotal:
{
Description: The pre-tax charged amount for the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
tax:
{
Description: The tax amount applied to the transaction. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
unitOfMeasure:
{
Description: The unit of measure used to bill for the product. For example, compute services are billed per hour. ,
Required: False ,
}
string ,
units:
{
Description: The number of units used for a given product. ,
Required: False ,
}
number ,
unitType:
{
Description: The description for the unit of measure for a given product. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Policies_GetByBillingProfile (removed)
Description :  Lists the policies for a billing profile. This operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/policies/default
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a policy. ,
Required: False ,
}
{
marketplacePurchases:
{
Description: The policy that controls whether Azure marketplace purchases are allowed for a billing profile. ,
Enum:
{
AllAllowed: No description available. ,
OnlyFreeAllowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
reservationPurchases:
{
Description: The policy that controls whether Azure reservation purchases are allowed for a billing profile. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
viewCharges:
{
Description: The policy that controls whether users with Azure RBAC access to a subscription can view its charges. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Policies_Update (removed)
Description :  Updates the policies for a billing profile. This operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/policies/default
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the update policies operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of a policy. ,
Required: False ,
}
{
marketplacePurchases:
{
Description: The policy that controls whether Azure marketplace purchases are allowed for a billing profile. ,
Enum:
{
AllAllowed: No description available. ,
OnlyFreeAllowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
reservationPurchases:
{
Description: The policy that controls whether Azure reservation purchases are allowed for a billing profile. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
viewCharges:
{
Description: The policy that controls whether users with Azure RBAC access to a subscription can view its charges. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a policy. ,
Required: False ,
}
{
marketplacePurchases:
{
Description: The policy that controls whether Azure marketplace purchases are allowed for a billing profile. ,
Enum:
{
AllAllowed: No description available. ,
OnlyFreeAllowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
reservationPurchases:
{
Description: The policy that controls whether Azure reservation purchases are allowed for a billing profile. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
viewCharges:
{
Description: The policy that controls whether users with Azure RBAC access to a subscription can view its charges. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Policies_GetByCustomer (removed)
Description :  Lists the policies for a customer. This operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/policies/default
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a customer's policy. ,
Required: False ,
}
{
viewCharges:
{
Description: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Policies_UpdateCustomer (removed)
Description :  Updates the policies for a customer. This operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/policies/default
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the update policies operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of a customer's policy. ,
Required: False ,
}
{
viewCharges:
{
Description: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a customer's policy. ,
Required: False ,
}
{
viewCharges:
{
Description: The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices. ,
Enum:
{
Allowed: No description available. ,
NotAllowed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingProperty_Get (removed)
Description :  Get the billing properties for a subscription. This operation is not supported for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingProperty/default
{
subscriptionId:
{
Description: The ID that uniquely identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A billing property. ,
Required: False ,
}
{
billingTenantId:
{
Description: The Azure AD tenant ID of the billing account for the subscription. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The ID of the billing account to which the subscription is billed. ,
Required: False ,
}
string ,
billingAccountDisplayName:
{
Description: The name of the billing account to which the subscription is billed. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the subscription is billed. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile to which the subscription is billed. ,
Required: False ,
}
string ,
billingProfileStatus:
{
Description: The status of the billing profile. ,
Enum:
{
Active: No description available. ,
Disabled: No description available. ,
Warned: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfileStatusReasonCode:
{
Description: Reason for the specified billing profile status. ,
Enum:
{
PastDue: No description available. ,
SpendingLimitReached: No description available. ,
SpendingLimitExpired: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfileSpendingLimit:
{
Description: The billing profile spending limit. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
costCenter:
{
Description: The cost center applied to the subscription. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the subscription is billed. ,
Required: False ,
}
string ,
invoiceSectionDisplayName:
{
Description: The name of the invoice section to which the subscription is billed. ,
Required: False ,
}
string ,
productId:
{
Description: The product ID of the Azure plan. ,
Required: False ,
}
string ,
productName:
{
Description: The product name of the Azure plan. ,
Required: False ,
}
string ,
skuId:
{
Description: The sku ID of the Azure plan for the subscription. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the Azure plan for the subscription. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Products_UpdateAutoRenewByInvoiceSection (removed)
Description :  Cancel auto renew for product by product id and invoice section name
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/products/{productName}/updateAutoRenew
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
productName:
{
Description: The ID that uniquely identifies a product. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
body:
{
Description: Request parameters that are provided to the update auto renew operation. ,
Required: True ,
}
{
autoRenew:
{
Description: The flag that determines the auto-renew settings for a product. ,
Enum:
{
true: No description available. ,
false: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Summary of update auto renew operation properties ,
Required: False ,
}
{
endDate:
{
Description: The date at which the product will be canceled. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
InvoiceSections_ElevateToBillingProfile (removed)
Description :  Gives the caller permissions on an invoice section based on their billing profile access. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/elevate
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Transfers_Initiate (removed)
Description :  Sends a request to a user in another billing account to transfer billing ownership of their subscriptions. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/initiateTransfer
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the initiate transfer operation. ,
Required: True ,
}
{
properties:
{
Description: Request parameters to initiate transfer. ,
Required: False ,
}
{
recipientEmailId:
{
Description: The email ID of the recipient to whom the transfer request is sent. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: The time at which the transfer request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The ID of the billing account to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
resellerName:
{
Description: Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
initiatorCustomerType:
{
Description: The type of customer who sent the transfer request. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product will be billed after the transfer. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The time at which the transfer request was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Transfers_Get (removed)
Description :  Gets a transfer request by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/transfers/{transferName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: The time at which the transfer request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The ID of the billing account to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
resellerName:
{
Description: Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
initiatorCustomerType:
{
Description: The type of customer who sent the transfer request. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product will be billed after the transfer. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The time at which the transfer request was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Transfers_Cancel (removed)
Description :  Cancels a transfer request. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/transfers/{transferName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: The time at which the transfer request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The ID of the billing account to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
resellerName:
{
Description: Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
initiatorCustomerType:
{
Description: The type of customer who sent the transfer request. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product will be billed after the transfer. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The time at which the transfer request was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Transfers_List (removed)
Description :  Lists the transfer requests for an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/transfers
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of transfers initiated by caller. ,
Required: False ,
}
[
{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: The time at which the transfer request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The ID of the billing account to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
resellerName:
{
Description: Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
initiatorCustomerType:
{
Description: The type of customer who sent the transfer request. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product will be billed after the transfer. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The time at which the transfer request was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
PartnerTransfers_Initiate (removed)
Description :  Sends a request to a user in a customer's billing account to transfer billing ownership of their subscriptions. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/initiateTransfer
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the initiate transfer operation. ,
Required: True ,
}
{
properties:
{
Description: Request parameters to initiate transfer. ,
Required: False ,
}
{
recipientEmailId:
{
Description: The email ID of the recipient to whom the transfer request is sent. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: The time at which the transfer request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The ID of the billing account to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
resellerName:
{
Description: Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
initiatorCustomerType:
{
Description: The type of customer who sent the transfer request. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product will be billed after the transfer. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The time at which the transfer request was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
PartnerTransfers_Get (removed)
Description :  Gets a transfer request by ID. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/transfers/{transferName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: The time at which the transfer request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The ID of the billing account to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
resellerName:
{
Description: Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
initiatorCustomerType:
{
Description: The type of customer who sent the transfer request. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product will be billed after the transfer. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The time at which the transfer request was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
PartnerTransfers_Cancel (removed)
Description :  Cancels a transfer request. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/transfers/{transferName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: The time at which the transfer request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The ID of the billing account to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
resellerName:
{
Description: Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
initiatorCustomerType:
{
Description: The type of customer who sent the transfer request. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product will be billed after the transfer. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The time at which the transfer request was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
PartnerTransfers_List (removed)
Description :  Lists the transfer requests sent to a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers/{customerName}/transfers
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
customerName:
{
Description: The ID that uniquely identifies a customer. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of transfers initiated by caller. ,
Required: False ,
}
[
{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: The time at which the transfer request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The ID of the invoice section to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: The ID of the billing account to which the product is billed after the transfer request is completed. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
resellerName:
{
Description: Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
initiatorCustomerType:
{
Description: The type of customer who sent the transfer request. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The ID of the billing profile to which the product will be billed after the transfer. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The time at which the transfer request was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
RecipientTransfers_Accept (removed)
Description :  Accepts a transfer request.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/transfers/{transferName}/acceptTransfer
{
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the accept transfer operation. ,
Required: True ,
}
{
properties:
{
Description: Request parameters to accept transfer. ,
Required: False ,
}
{
productDetails:
{
Description: Request parameters to accept transfer. ,
Required: False ,
}
[
{
productType:
{
Description: Type of the product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: The time at which the transfer request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
allowedProductType:
{
Description: Type of subscriptions that can be transferred. ,
Required: False ,
}
[
string ,
]
,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
resellerName:
{
Description: Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
initiatorCustomerType:
{
Description: The type of customer who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The time at which the transfer request was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
RecipientTransfers_Validate (removed)
Description :  Validates if a subscription or a reservation can be transferred. Use this operation to validate your subscriptions or reservation before using the accept transfer operation.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/transfers/{transferName}/validateTransfer
{
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the validate transfer operation. ,
Required: True ,
}
{
properties:
{
Description: Request parameters to accept transfer. ,
Required: False ,
}
{
productDetails:
{
Description: Request parameters to accept transfer. ,
Required: False ,
}
[
{
productType:
{
Description: Type of the product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of transfer validation results. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of transfer validation response. ,
Required: False ,
}
{
status:
{
Description: The status of validation ,
Required: False ,
}
string ,
productId:
{
Description: The product id for which this result applies. ,
Required: False ,
}
string ,
results:
{
Description: The array of validation results. ,
Required: False ,
}
[
{
level:
{
Description: Result Level. ,
Required: False ,
}
string ,
code:
{
Description: Result Code. ,
Required: False ,
}
string ,
message:
{
Description: The validation message. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
RecipientTransfers_Decline (removed)
Description :  Declines a transfer request.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/transfers/{transferName}/declineTransfer
{
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: The time at which the transfer request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
allowedProductType:
{
Description: Type of subscriptions that can be transferred. ,
Required: False ,
}
[
string ,
]
,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
resellerName:
{
Description: Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
initiatorCustomerType:
{
Description: The type of customer who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The time at which the transfer request was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
RecipientTransfers_Get (removed)
Description :  Gets a transfer request by ID. The caller must be the recipient of the transfer request.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/transfers/{transferName}
{
transferName:
{
Description: The ID that uniquely identifies a transfer request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: The time at which the transfer request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
allowedProductType:
{
Description: Type of subscriptions that can be transferred. ,
Required: False ,
}
[
string ,
]
,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
resellerName:
{
Description: Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
initiatorCustomerType:
{
Description: The type of customer who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The time at which the transfer request was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
RecipientTransfers_List (removed)
Description :  Lists the transfer requests received by the caller.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/transfers
{}

⚐ Response (200)

{
value:
{
Description: The list of transfers received by caller. ,
Required: False ,
}
[
{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: The time at which the transfer request was created. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: The time at which the transfer request expires. ,
Format: date-time ,
Required: False ,
}
string ,
allowedProductType:
{
Description: Type of subscriptions that can be transferred. ,
Required: False ,
}
[
string ,
]
,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: The email ID of the user to whom the transfer request was sent. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: The email ID of the user who sent the transfer request. ,
Required: False ,
}
string ,
resellerId:
{
Description: Optional MPN ID of the reseller for transfer requests that are sent from a Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
resellerName:
{
Description: Optional name of the reseller for transfer requests that are sent from Microsoft Partner Agreement billing account. ,
Required: False ,
}
string ,
initiatorCustomerType:
{
Description: The type of customer who sent the transfer request. ,
Required: False ,
}
string ,
canceledBy:
{
Description: The email ID of the user who canceled the transfer request. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: The time at which the transfer request was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product that is transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: The ID of the product that is transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  Lists the available billing REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/operations
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing operations supported by the Microsoft.Billing resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.Billing. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed such as invoice and billing subscription. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type such as read, write and delete. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingPermissions_ListByBillingAccount (removed)
Description :  Lists the billing permissions the caller has on a billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingPermissions
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billingPermissions a caller has on a billing account. ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingPermissions_ListByInvoiceSections (removed)
Description :  Lists the billing permissions the caller has on an invoice section.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingPermissions
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billingPermissions a caller has on a billing account. ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingPermissions_ListByBillingProfile (removed)
Description :  Lists the billing permissions the caller has on a billing profile.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingPermissions
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billingPermissions a caller has on a billing account. ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingPermissions_ListByDepartment (removed)
Description :  Lists the billing permissions the caller has on a department.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingPermissions
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
departmentName:
{
Description: The ID that uniquely identifies a department. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billingPermissions a caller has on a billing account. ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingPermissions_ListByEnrollmentAccount (removed)
Description :  Lists the billing permissions the caller has on an enrollment account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingPermissions
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
enrollmentAccountName:
{
Description: The ID that uniquely identifies an enrollment account. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billingPermissions a caller has on a billing account. ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleDefinitions_GetByBillingAccount (removed)
Description :  Gets the definition for a role on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/{billingRoleDefinitionName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingRoleDefinitionName:
{
Description: The ID that uniquely identifies a role definition. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the a role definition. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
roleName:
{
Description: The name of the role ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleDefinitions_GetByInvoiceSection (removed)
Description :  Gets the definition for a role on an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleDefinitions/{billingRoleDefinitionName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
billingRoleDefinitionName:
{
Description: The ID that uniquely identifies a role definition. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the a role definition. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
roleName:
{
Description: The name of the role ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleDefinitions_GetByBillingProfile (removed)
Description :  Gets the definition for a role on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleDefinitions/{billingRoleDefinitionName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
billingRoleDefinitionName:
{
Description: The ID that uniquely identifies a role definition. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the a role definition. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
roleName:
{
Description: The name of the role ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleDefinitions_GetByDepartment (removed)
Description :  Gets the definition for a role on a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingRoleDefinitions/{billingRoleDefinitionName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
departmentName:
{
Description: The ID that uniquely identifies a department. ,
Required: True ,
}
string ,
billingRoleDefinitionName:
{
Description: The ID that uniquely identifies a role definition. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the a role definition. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
roleName:
{
Description: The name of the role ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleDefinitions_GetByEnrollmentAccount (removed)
Description :  Gets the definition for a role on an enrollment account. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingRoleDefinitions/{billingRoleDefinitionName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
enrollmentAccountName:
{
Description: The ID that uniquely identifies an enrollment account. ,
Required: True ,
}
string ,
billingRoleDefinitionName:
{
Description: The ID that uniquely identifies a role definition. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the a role definition. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
roleName:
{
Description: The name of the role ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleDefinitions_ListByBillingAccount (removed)
Description :  Lists the role definitions for a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The role definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the a role definition. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
roleName:
{
Description: The name of the role ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleDefinitions_ListByInvoiceSection (removed)
Description :  Lists the role definitions for an invoice section. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleDefinitions
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The role definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the a role definition. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
roleName:
{
Description: The name of the role ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleDefinitions_ListByBillingProfile (removed)
Description :  Lists the role definitions for a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleDefinitions
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The role definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the a role definition. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
roleName:
{
Description: The name of the role ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleDefinitions_ListByDepartment (removed)
Description :  Lists the role definitions for a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingRoleDefinitions
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
departmentName:
{
Description: The ID that uniquely identifies a department. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The role definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the a role definition. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
roleName:
{
Description: The name of the role ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleDefinitions_ListByEnrollmentAccount (removed)
Description :  Lists the role definitions for a enrollmentAccount. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingRoleDefinitions
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
enrollmentAccountName:
{
Description: The ID that uniquely identifies an enrollment account. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The role definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the a role definition. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
[
{
actions:
{
Description: The set of actions that the caller is allowed to perform. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions that the caller is not allowed to perform. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
roleName:
{
Description: The name of the role ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_GetByBillingAccount (removed)
Description :  Gets a role assignment for the caller on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_DeleteByBillingAccount (removed)
Description :  Deletes a role assignment for the caller on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
RoleAssignments_Put (removed)
Description :  Create or update a billing role assignment.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
parameters:
{
Description: The new or updated billing role assignment. ,
Required: True ,
}
{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_GetByInvoiceSection (removed)
Description :  Gets a role assignment for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_DeleteByInvoiceSection (removed)
Description :  Deletes a role assignment for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_GetByBillingProfile (removed)
Description :  Gets a role assignment for the caller on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_DeleteByBillingProfile (removed)
Description :  Deletes a role assignment for the caller on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_GetByDepartment (removed)
Description :  Gets a role assignment for the caller on a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
departmentName:
{
Description: The ID that uniquely identifies a department. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_DeleteByDepartment (removed)
Description :  Deletes a role assignment for the caller on a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
departmentName:
{
Description: The ID that uniquely identifies a department. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
EnrollmentDepartmentRoleAssignments_Put (removed)
Description :  Create or update a billing role assignment.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
departmentName:
{
Description: The ID that uniquely identifies a department. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
parameters:
{
Description: The new or updated billing role assignment. ,
Required: True ,
}
{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_GetByEnrollmentAccount (removed)
Description :  Gets a role assignment for the caller on a enrollment Account. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
enrollmentAccountName:
{
Description: The ID that uniquely identifies an enrollment account. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_DeleteByEnrollmentAccount (removed)
Description :  Deletes a role assignment for the caller on a enrollment Account. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
enrollmentAccountName:
{
Description: The ID that uniquely identifies an enrollment account. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
EnrollmentAccountRoleAssignments_Put (removed)
Description :  Create or update a billing role assignment.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
enrollmentAccountName:
{
Description: The ID that uniquely identifies an enrollment account. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: The ID that uniquely identifies a role assignment. ,
Required: True ,
}
string ,
parameters:
{
Description: The new or updated billing role assignment. ,
Required: True ,
}
{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_ListByBillingAccount (removed)
Description :  Lists the role assignments for the caller on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of role assignments. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_AddByBillingAccount (removed)
Description :  Adds a role assignment on a billing account. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/createBillingRoleAssignment
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the create billing role assignment operation. ,
Required: True ,
}
{
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
billingRoleDefinitionId:
{
Description: The role definition id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
value:
{
Description: The list of role assignments. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_ListByInvoiceSection (removed)
Description :  Lists the role assignments for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleAssignments
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of role assignments. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_AddByInvoiceSection (removed)
Description :  Adds a role assignment on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/createBillingRoleAssignment
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: The ID that uniquely identifies an invoice section. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the create billing role assignment operation. ,
Required: True ,
}
{
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
billingRoleDefinitionId:
{
Description: The role definition id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
value:
{
Description: The list of role assignments. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_ListByBillingProfile (removed)
Description :  Lists the role assignments for the caller on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleAssignments
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of role assignments. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_AddByBillingProfile (removed)
Description :  Adds a role assignment on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/createBillingRoleAssignment
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the create billing role assignment operation. ,
Required: True ,
}
{
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
billingRoleDefinitionId:
{
Description: The role definition id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
value:
{
Description: The list of role assignments. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_ListByDepartment (removed)
Description :  Lists the role assignments for the caller on a billing profile. The operation is supported for billing accounts of type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingRoleAssignments
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
departmentName:
{
Description: The ID that uniquely identifies a department. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of role assignments. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
BillingRoleAssignments_ListByEnrollmentAccount (removed)
Description :  Lists the role assignments for the caller on a billing profile. The operation is supported for billing accounts of type Enterprise Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingRoleAssignments
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
enrollmentAccountName:
{
Description: The ID that uniquely identifies an enrollment account. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of role assignments. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the role assignment. ,
Required: False ,
}
{
createdOn:
{
Description: The date the role assignment was created. ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: The tenant Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: The principal Id of the user who created the role assignment. ,
Required: False ,
}
string ,
createdByUserEmailAddress:
{
Description: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
name:
{
Description: The name of the role assignment. ,
Required: False ,
}
string ,
principalId:
{
Description: The principal id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
principalTenantId:
{
Description: The principal tenant id of the user to whom the role was assigned. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The ID of the role definition. ,
Required: False ,
}
string ,
scope:
{
Description: The scope at which the role was assigned. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
userAuthenticationType:
{
Description: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Agreements_ListByBillingAccount (removed)
Description :  Lists the agreements for a billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the participants. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of agreements. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an agreement. ,
Required: False ,
}
{
agreementLink:
{
Description: The URL to download the agreement. ,
Required: False ,
}
string ,
category:
{
Description: The category of the agreement signed by a customer. ,
Enum:
{
MicrosoftCustomerAgreement: No description available. ,
AffiliatePurchaseTerms: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
acceptanceMode:
{
Description: The mode of acceptance for an agreement. ,
Enum:
{
ClickToAccept: No description available. ,
ESignEmbedded: No description available. ,
ESignOffline: No description available. ,
}
,
Required: False ,
}
enum ,
effectiveDate:
{
Description: The date from which the agreement is effective. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date when the agreement expires. ,
Format: date-time ,
Required: False ,
}
string ,
participants:
{
Description: The list of participants that participates in acceptance of an agreement. ,
Required: False ,
}
[
{
status:
{
Description: The acceptance status of the participant. ,
Required: False ,
}
string ,
statusDate:
{
Description: The date when the status got changed. ,
Format: date-time ,
Required: False ,
}
string ,
email:
{
Description: The email address of the participant. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The current status of the agreement. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Agreements_Get (removed)
Description :  Gets an agreement by ID.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements/{agreementName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
agreementName:
{
Description: The ID that uniquely identifies an agreement. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the participants. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an agreement. ,
Required: False ,
}
{
agreementLink:
{
Description: The URL to download the agreement. ,
Required: False ,
}
string ,
category:
{
Description: The category of the agreement signed by a customer. ,
Enum:
{
MicrosoftCustomerAgreement: No description available. ,
AffiliatePurchaseTerms: No description available. ,
Other: No description available. ,
}
,
Required: False ,
}
enum ,
acceptanceMode:
{
Description: The mode of acceptance for an agreement. ,
Enum:
{
ClickToAccept: No description available. ,
ESignEmbedded: No description available. ,
ESignOffline: No description available. ,
}
,
Required: False ,
}
enum ,
effectiveDate:
{
Description: The date from which the agreement is effective. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date when the agreement expires. ,
Format: date-time ,
Required: False ,
}
string ,
participants:
{
Description: The list of participants that participates in acceptance of an agreement. ,
Required: False ,
}
[
{
status:
{
Description: The acceptance status of the participant. ,
Required: False ,
}
string ,
statusDate:
{
Description: The date when the status got changed. ,
Format: date-time ,
Required: False ,
}
string ,
email:
{
Description: The email address of the participant. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The current status of the agreement. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub details of the error. ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}