Microsoft.Billing (stable:2020-05-01)

2025/09/26 • 75 new, 75 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 2020-05-01. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the soldTo, 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 ,
soldTo:
{
Description: The address of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
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 ,
accountType:
{
Description: The type of customer. ,
Enum:
{
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatus:
{
Description: The current status of the billing account. ,
Enum:
{
Active: No description available. ,
Deleted: No description available. ,
Disabled: No description available. ,
Expired: No description available. ,
Transferred: No description available. ,
Extended: No description available. ,
Terminated: 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 ,
}
{
hasMoreResults:
{
Description: Indicates whether there are more billing profiles than the ones listed in this collection. The collection lists a maximum of 50 billing profiles. To get all billing profiles, use the list billing profiles API. ,
Required: False ,
}
boolean ,
value:
{
Description: The billing profiles associated with the billing account. ,
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 ,
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 ,
billTo:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
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 ,
}
,
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 ,
}
,
]
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
hasMoreResults:
{
Description: Indicates whether there are more invoice sections than the ones listed in this collection. The collection lists a maximum of 50 invoice sections. To get all invoice sections, use the list invoice sections API. ,
Required: False ,
}
boolean ,
value:
{
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 ,
labels:
{
Description: Dictionary of metadata associated with the invoice section. ,
Required: False ,
}
object ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the invoice section. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
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 ,
}
,
}
,
]
,
}
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing profile. ,
Required: False ,
}
boolean ,
systemId:
{
Description: The system generated unique identifier for a billing profile. ,
Required: False ,
}
string ,
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 ,
]
,
tags:
{
Description: Tags of billing profiles. ,
Required: False ,
}
object ,
}
,
}
,
]
,
}
,
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 ,
marketplaceEnabled:
{
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 ,
accountOwnerEmail:
{
Description: The enrollment account owner email address. ,
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 ,
accountOwnerEmail:
{
Description: The enrollment account owner email address. ,
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 ,
}
,
}
,
]
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing account. ,
Required: False ,
}
boolean ,
notificationEmailAddress:
{
Description: Notification email address, only for legacy accounts ,
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 2020-05-01. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the soldTo, 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 ,
soldTo:
{
Description: The address of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
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 ,
accountType:
{
Description: The type of customer. ,
Enum:
{
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatus:
{
Description: The current status of the billing account. ,
Enum:
{
Active: No description available. ,
Deleted: No description available. ,
Disabled: No description available. ,
Expired: No description available. ,
Transferred: No description available. ,
Extended: No description available. ,
Terminated: 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 ,
}
{
hasMoreResults:
{
Description: Indicates whether there are more billing profiles than the ones listed in this collection. The collection lists a maximum of 50 billing profiles. To get all billing profiles, use the list billing profiles API. ,
Required: False ,
}
boolean ,
value:
{
Description: The billing profiles associated with the billing account. ,
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 ,
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 ,
billTo:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
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 ,
}
,
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 ,
}
,
]
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
hasMoreResults:
{
Description: Indicates whether there are more invoice sections than the ones listed in this collection. The collection lists a maximum of 50 invoice sections. To get all invoice sections, use the list invoice sections API. ,
Required: False ,
}
boolean ,
value:
{
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 ,
labels:
{
Description: Dictionary of metadata associated with the invoice section. ,
Required: False ,
}
object ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the invoice section. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
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 ,
}
,
}
,
]
,
}
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing profile. ,
Required: False ,
}
boolean ,
systemId:
{
Description: The system generated unique identifier for a billing profile. ,
Required: False ,
}
string ,
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 ,
]
,
tags:
{
Description: Tags of billing profiles. ,
Required: False ,
}
object ,
}
,
}
,
]
,
}
,
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 ,
marketplaceEnabled:
{
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 ,
accountOwnerEmail:
{
Description: The enrollment account owner email address. ,
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 ,
accountOwnerEmail:
{
Description: The enrollment account owner email address. ,
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 ,
}
,
}
,
]
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing account. ,
Required: False ,
}
boolean ,
notificationEmailAddress:
{
Description: Notification email address, only for legacy accounts ,
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 2020-05-01. ,
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 ,
soldTo:
{
Description: The address of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
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 ,
accountType:
{
Description: The type of customer. ,
Enum:
{
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatus:
{
Description: The current status of the billing account. ,
Enum:
{
Active: No description available. ,
Deleted: No description available. ,
Disabled: No description available. ,
Expired: No description available. ,
Transferred: No description available. ,
Extended: No description available. ,
Terminated: 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 ,
}
{
hasMoreResults:
{
Description: Indicates whether there are more billing profiles than the ones listed in this collection. The collection lists a maximum of 50 billing profiles. To get all billing profiles, use the list billing profiles API. ,
Required: False ,
}
boolean ,
value:
{
Description: The billing profiles associated with the billing account. ,
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 ,
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 ,
billTo:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
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 ,
}
,
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 ,
}
,
]
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
hasMoreResults:
{
Description: Indicates whether there are more invoice sections than the ones listed in this collection. The collection lists a maximum of 50 invoice sections. To get all invoice sections, use the list invoice sections API. ,
Required: False ,
}
boolean ,
value:
{
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 ,
labels:
{
Description: Dictionary of metadata associated with the invoice section. ,
Required: False ,
}
object ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the invoice section. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
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 ,
}
,
}
,
]
,
}
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing profile. ,
Required: False ,
}
boolean ,
systemId:
{
Description: The system generated unique identifier for a billing profile. ,
Required: False ,
}
string ,
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 ,
]
,
tags:
{
Description: Tags of billing profiles. ,
Required: False ,
}
object ,
}
,
}
,
]
,
}
,
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 ,
marketplaceEnabled:
{
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 ,
accountOwnerEmail:
{
Description: The enrollment account owner email address. ,
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 ,
accountOwnerEmail:
{
Description: The enrollment account owner email address. ,
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 ,
}
,
}
,
]
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing account. ,
Required: False ,
}
boolean ,
notificationEmailAddress:
{
Description: Notification email address, only for legacy accounts ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the billing account. ,
Required: False ,
}
{
displayName:
{
Description: The billing account name. ,
Required: False ,
}
string ,
soldTo:
{
Description: The address of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
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 ,
accountType:
{
Description: The type of customer. ,
Enum:
{
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatus:
{
Description: The current status of the billing account. ,
Enum:
{
Active: No description available. ,
Deleted: No description available. ,
Disabled: No description available. ,
Expired: No description available. ,
Transferred: No description available. ,
Extended: No description available. ,
Terminated: 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 ,
}
{
hasMoreResults:
{
Description: Indicates whether there are more billing profiles than the ones listed in this collection. The collection lists a maximum of 50 billing profiles. To get all billing profiles, use the list billing profiles API. ,
Required: False ,
}
boolean ,
value:
{
Description: The billing profiles associated with the billing account. ,
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 ,
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 ,
billTo:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
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 ,
}
,
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 ,
}
,
]
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
hasMoreResults:
{
Description: Indicates whether there are more invoice sections than the ones listed in this collection. The collection lists a maximum of 50 invoice sections. To get all invoice sections, use the list invoice sections API. ,
Required: False ,
}
boolean ,
value:
{
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 ,
labels:
{
Description: Dictionary of metadata associated with the invoice section. ,
Required: False ,
}
object ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the invoice section. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
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 ,
}
,
}
,
]
,
}
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing profile. ,
Required: False ,
}
boolean ,
systemId:
{
Description: The system generated unique identifier for a billing profile. ,
Required: False ,
}
string ,
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 ,
]
,
tags:
{
Description: Tags of billing profiles. ,
Required: False ,
}
object ,
}
,
}
,
]
,
}
,
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 ,
marketplaceEnabled:
{
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 ,
accountOwnerEmail:
{
Description: The enrollment account owner email address. ,
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 ,
accountOwnerEmail:
{
Description: The enrollment account owner email address. ,
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 ,
}
,
}
,
]
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing account. ,
Required: False ,
}
boolean ,
notificationEmailAddress:
{
Description: Notification email address, only for legacy accounts ,
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 2020-05-01. ,
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 ,
invoiceSectionSystemId:
{
Description: The system generated unique identifier for an 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 ,
billingProfileSystemId:
{
Description: The system generated unique identifier for a billing profile. ,
Required: False ,
}
string ,
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 ,
}
,
]
,
}
,
}
Address_Validate (new)
Description :  Validates an address. Use the operation to validate an address before using it as soldTo or a billTo 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 2020-05-01. ,
Required: True ,
}
string ,
address:
{
Required: True ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
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 ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
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_Get (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 2020-05-01. ,
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 2020-05-01. ,
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 2020-05-01. ,
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 2020-05-01. ,
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 ,
}
,
]
,
}
,
}
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 2020-05-01. ,
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 ,
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 ,
billTo:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
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 ,
}
,
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 ,
}
,
]
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
hasMoreResults:
{
Description: Indicates whether there are more invoice sections than the ones listed in this collection. The collection lists a maximum of 50 invoice sections. To get all invoice sections, use the list invoice sections API. ,
Required: False ,
}
boolean ,
value:
{
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 ,
labels:
{
Description: Dictionary of metadata associated with the invoice section. ,
Required: False ,
}
object ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the invoice section. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
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 ,
}
,
}
,
]
,
}
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing profile. ,
Required: False ,
}
boolean ,
systemId:
{
Description: The system generated unique identifier for a billing profile. ,
Required: False ,
}
string ,
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 ,
]
,
tags:
{
Description: Tags of billing profiles. ,
Required: False ,
}
object ,
}
,
}
,
]
,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
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 2020-05-01. ,
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 ,
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 ,
billTo:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
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 ,
}
,
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 ,
}
,
]
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
hasMoreResults:
{
Description: Indicates whether there are more invoice sections than the ones listed in this collection. The collection lists a maximum of 50 invoice sections. To get all invoice sections, use the list invoice sections API. ,
Required: False ,
}
boolean ,
value:
{
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 ,
labels:
{
Description: Dictionary of metadata associated with the invoice section. ,
Required: False ,
}
object ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the invoice section. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
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 ,
}
,
}
,
]
,
}
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing profile. ,
Required: False ,
}
boolean ,
systemId:
{
Description: The system generated unique identifier for a billing profile. ,
Required: False ,
}
string ,
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 ,
]
,
tags:
{
Description: Tags of billing profiles. ,
Required: False ,
}
object ,
}
,
}

⚐ 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_CreateOrUpdate (new)
Description :  Creates or updates 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 2020-05-01. ,
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: The new or updated billing profile. ,
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 ,
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 ,
billTo:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
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 ,
}
,
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 ,
}
,
]
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
hasMoreResults:
{
Description: Indicates whether there are more invoice sections than the ones listed in this collection. The collection lists a maximum of 50 invoice sections. To get all invoice sections, use the list invoice sections API. ,
Required: False ,
}
boolean ,
value:
{
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 ,
labels:
{
Description: Dictionary of metadata associated with the invoice section. ,
Required: False ,
}
object ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the invoice section. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
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 ,
}
,
}
,
]
,
}
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing profile. ,
Required: False ,
}
boolean ,
systemId:
{
Description: The system generated unique identifier for a billing profile. ,
Required: False ,
}
string ,
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 ,
]
,
tags:
{
Description: Tags of billing profiles. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ 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 ,
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 ,
billTo:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
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 ,
}
,
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 ,
}
,
]
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
hasMoreResults:
{
Description: Indicates whether there are more invoice sections than the ones listed in this collection. The collection lists a maximum of 50 invoice sections. To get all invoice sections, use the list invoice sections API. ,
Required: False ,
}
boolean ,
value:
{
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 ,
labels:
{
Description: Dictionary of metadata associated with the invoice section. ,
Required: False ,
}
object ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the invoice section. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
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 ,
}
,
}
,
]
,
}
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing profile. ,
Required: False ,
}
boolean ,
systemId:
{
Description: The system generated unique identifier for a billing profile. ,
Required: False ,
}
string ,
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 ,
]
,
tags:
{
Description: Tags of billing profiles. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
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 2020-05-01. ,
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 ,
$search:
{
Description: Used for searching customers by their name. Any customer with name containing the search text will be included in the response ,
Required: False ,
}
string ,
$filter:
{
Description: May be used to filter the list of customers. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of customers. ,
Required: False ,
}
[
{
properties:
{
Description: The customer. ,
Required: False ,
}
{
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 ,
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 ,
}
,
]
,
}
,
}
,
]
,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
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 2020-05-01. ,
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 ,
labels:
{
Description: Dictionary of metadata associated with the invoice section. ,
Required: False ,
}
object ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the invoice section. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
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 ,
}
,
}
,
]
,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
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 2020-05-01. ,
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 ,
labels:
{
Description: Dictionary of metadata associated with the invoice section. ,
Required: False ,
}
object ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the invoice section. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
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_CreateOrUpdate (new)
Description :  Creates or updates 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 2020-05-01. ,
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: The new or updated invoice section. ,
Required: True ,
}
{
properties:
{
Description: The properties of an invoice section. ,
Required: False ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
labels:
{
Description: Dictionary of metadata associated with the invoice section. ,
Required: False ,
}
object ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the invoice section. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
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 ,
labels:
{
Description: Dictionary of metadata associated with the invoice section. ,
Required: False ,
}
object ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the invoice section. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
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 ,
}
,
]
,
}
,
}
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 2020-05-01. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
$search:
{
Description: Used for searching customers by their name. Any customer with name containing the search text will be included in the response ,
Required: False ,
}
string ,
$filter:
{
Description: May be used to filter the list of customers. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of customers. ,
Required: False ,
}
[
{
properties:
{
Description: The customer. ,
Required: False ,
}
{
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 ,
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 ,
}
,
]
,
}
,
}
,
]
,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
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 2020-05-01. ,
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 ,
}
{
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 ,
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 2020-05-01. ,
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 2020-05-01. ,
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 ,
costCenter:
{
Description: The cost center applied to the subscription. ,
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 ,
suspensionReasons:
{
Description: The suspension reason for a subscription. Applies only to subscriptions in Microsoft Online Services Program billing accounts. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
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_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 2020-05-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of products. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a product. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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 ,
}
,
}
,
}
,
]
,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
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_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 or Microsoft Customer 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 2020-05-01. ,
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 ,
source:
{
Description: The source of the document. ENF for Brazil and DRS for rest of the world. ,
Enum:
{
DRS: No description available. ,
ENF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
rebillDetails:
{
Description: Rebill details for an invoice. ,
Required: False ,
}
object ,
documentType:
{
Description: The type of the document. ,
Enum:
{
Invoice: No description available. ,
CreditNote: No description available. ,
}
,
Required: False ,
}
enum ,
billedDocumentId:
{
Description: The Id of the active invoice which is originally billed after this invoice was voided. This field is applicable to the void invoices only. ,
Required: False ,
}
string ,
creditForDocumentId:
{
Description: The Id of the invoice which got voided and this credit note was issued as a result. This field is applicable to the credit notes only. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
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_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 2020-05-01. ,
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 ,
source:
{
Description: The source of the document. ENF for Brazil and DRS for rest of the world. ,
Enum:
{
DRS: No description available. ,
ENF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
rebillDetails:
{
Description: Rebill details for an invoice. ,
Required: False ,
}
object ,
documentType:
{
Description: The type of the document. ,
Enum:
{
Invoice: No description available. ,
CreditNote: No description available. ,
}
,
Required: False ,
}
enum ,
billedDocumentId:
{
Description: The Id of the active invoice which is originally billed after this invoice was voided. This field is applicable to the void invoices only. ,
Required: False ,
}
string ,
creditForDocumentId:
{
Description: The Id of the invoice which got voided and this credit note was issued as a result. This field is applicable to the credit notes only. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
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_Get (new)
Description :  Gets an invoice by billing account name and 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}/invoices/{invoiceName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2020-05-01. ,
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 ,
source:
{
Description: The source of the document. ENF for Brazil and DRS for rest of the world. ,
Enum:
{
DRS: No description available. ,
ENF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
rebillDetails:
{
Description: Rebill details for an invoice. ,
Required: False ,
}
object ,
documentType:
{
Description: The type of the document. ,
Enum:
{
Invoice: No description available. ,
CreditNote: No description available. ,
}
,
Required: False ,
}
enum ,
billedDocumentId:
{
Description: The Id of the active invoice which is originally billed after this invoice was voided. This field is applicable to the void invoices only. ,
Required: False ,
}
string ,
creditForDocumentId:
{
Description: The Id of the invoice which got voided and this credit note was issued as a result. This field is applicable to the credit notes only. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
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_GetById (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/default/invoices/{invoiceName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2020-05-01. ,
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 ,
source:
{
Description: The source of the document. ENF for Brazil and DRS for rest of the world. ,
Enum:
{
DRS: No description available. ,
ENF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
rebillDetails:
{
Description: Rebill details for an invoice. ,
Required: False ,
}
object ,
documentType:
{
Description: The type of the document. ,
Enum:
{
Invoice: No description available. ,
CreditNote: No description available. ,
}
,
Required: False ,
}
enum ,
billedDocumentId:
{
Description: The Id of the active invoice which is originally billed after this invoice was voided. This field is applicable to the void invoices only. ,
Required: False ,
}
string ,
creditForDocumentId:
{
Description: The Id of the invoice which got voided and this credit note was issued as a result. This field is applicable to the credit notes only. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
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_DownloadInvoice (new)
Description :  Gets a URL to download 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}/invoices/{invoiceName}/download
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2020-05-01. ,
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 ,
downloadToken:
{
Description: Download token with document source and document ID. ,
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_DownloadMultipleBillingProfileInvoices (new)
Description :  Gets a URL to download multiple invoice documents (invoice pdf, tax receipts, credit notes) as a zip file. 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}/downloadDocuments
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2020-05-01. ,
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 ,
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 ,
}
,
]
,
}
,
}
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 2020-05-01. ,
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 ,
costCenter:
{
Description: The cost center applied to the subscription. ,
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 ,
suspensionReasons:
{
Description: The suspension reason for a subscription. Applies only to subscriptions in Microsoft Online Services Program billing accounts. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
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/default/billingSubscriptions/{subscriptionId}/invoices
{
subscriptionId:
{
Description: The ID that uniquely identifies an Azure 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 2020-05-01. ,
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 ,
source:
{
Description: The source of the document. ENF for Brazil and DRS for rest of the world. ,
Enum:
{
DRS: No description available. ,
ENF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
rebillDetails:
{
Description: Rebill details for an invoice. ,
Required: False ,
}
object ,
documentType:
{
Description: The type of the document. ,
Enum:
{
Invoice: No description available. ,
CreditNote: No description available. ,
}
,
Required: False ,
}
enum ,
billedDocumentId:
{
Description: The Id of the active invoice which is originally billed after this invoice was voided. This field is applicable to the void invoices only. ,
Required: False ,
}
string ,
creditForDocumentId:
{
Description: The Id of the invoice which got voided and this credit note was issued as a result. This field is applicable to the credit notes only. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
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_GetBySubscriptionAndInvoiceId (new)
Description :  Gets an invoice by subscription ID and invoice ID.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/invoices/{invoiceName}
{
subscriptionId:
{
Description: The ID that uniquely identifies an Azure 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 2020-05-01. ,
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 ,
source:
{
Description: The source of the document. ENF for Brazil and DRS for rest of the world. ,
Enum:
{
DRS: No description available. ,
ENF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
rebillDetails:
{
Description: Rebill details for an invoice. ,
Required: False ,
}
object ,
documentType:
{
Description: The type of the document. ,
Enum:
{
Invoice: No description available. ,
CreditNote: No description available. ,
}
,
Required: False ,
}
enum ,
billedDocumentId:
{
Description: The Id of the active invoice which is originally billed after this invoice was voided. This field is applicable to the void invoices only. ,
Required: False ,
}
string ,
creditForDocumentId:
{
Description: The Id of the invoice which got voided and this credit note was issued as a result. This field is applicable to the credit notes only. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
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_DownloadBillingSubscriptionInvoice (new)
Description :  Gets a URL to download an invoice.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/invoices/{invoiceName}/download
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2020-05-01. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID that uniquely identifies an Azure subscription. ,
Required: True ,
}
string ,
invoiceName:
{
Description: The ID that uniquely identifies an invoice. ,
Required: True ,
}
string ,
downloadToken:
{
Description: Download token with document source and document ID. ,
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_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 2020-05-01. ,
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 ,
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 ,
}
,
]
,
}
,
}
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 2020-05-01. ,
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 ,
costCenter:
{
Description: The cost center applied to the subscription. ,
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 ,
suspensionReasons:
{
Description: The suspension reason for a subscription. Applies only to subscriptions in Microsoft Online Services Program billing accounts. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
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 2020-05-01. ,
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 ,
costCenter:
{
Description: The cost center applied to the subscription. ,
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 ,
suspensionReasons:
{
Description: The suspension reason for a subscription. Applies only to subscriptions in Microsoft Online Services Program billing accounts. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
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 for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{subscriptionId}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
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 2020-05-01. ,
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 ,
costCenter:
{
Description: The cost center applied to the subscription. ,
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 ,
suspensionReasons:
{
Description: The suspension reason for a subscription. Applies only to subscriptions in Microsoft Online Services Program billing accounts. ,
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_Update (new)
Description :  Updates the properties of a billing subscription. Currently, cost center 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}/billingSubscriptions/{subscriptionId}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
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 2020-05-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the update billing subscription operation. ,
Required: True ,
}
{
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 ,
costCenter:
{
Description: The cost center applied to the subscription. ,
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 ,
suspensionReasons:
{
Description: The suspension reason for a subscription. Applies only to subscriptions in Microsoft Online Services Program billing accounts. ,
Required: False ,
}
[
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 ,
costCenter:
{
Description: The cost center applied to the subscription. ,
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 ,
suspensionReasons:
{
Description: The suspension reason for a subscription. Applies only to subscriptions in Microsoft Online Services Program billing accounts. ,
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_Move (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 for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{subscriptionId}/move
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
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 2020-05-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the move subscription operation. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
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 ,
costCenter:
{
Description: The cost center applied to the subscription. ,
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 ,
suspensionReasons:
{
Description: The suspension reason for a subscription. Applies only to subscriptions in Microsoft Online Services Program billing accounts. ,
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_ValidateMove (new)
Description :  Validates if a subscription's charges can be moved to a new invoice section. This operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{subscriptionId}/validateMoveEligibility
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
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 2020-05-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the validate move eligibility operation. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
isMoveEligible:
{
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 2020-05-01. ,
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 ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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 ,
}
,
}
,
}
,
]
,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
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_ListByBillingProfile (new)
Description :  Lists the products for a billing profile. 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}/billingProfiles/{billingProfileName}/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 ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2020-05-01. ,
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 ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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 ,
}
,
}
,
}
,
]
,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
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 2020-05-01. ,
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 ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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 ,
}
,
}
,
}
,
]
,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
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}/products/{productName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
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 2020-05-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a product. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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_Update (new)
Description :  Updates the properties of a Product. Currently, auto renew 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}/products/{productName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
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 2020-05-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the update product operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of a product. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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 (200)

{
properties:
{
Description: The properties of a product. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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_Move (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}/products/{productName}/move
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
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 2020-05-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the move product operation. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a product. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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_ValidateMove (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}/products/{productName}/validateMoveEligibility
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
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 2020-05-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the validate move eligibility operation. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
isMoveEligible:
{
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_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}/invoices/{invoiceName}/transactions
{
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 ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2020-05-01. ,
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 ,
invoiceId:
{
Description: The ID of the invoice on which the transaction was billed. This field is only applicable for transactions which are 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 ,
azurePlan:
{
Description: The type of azure plan of the subscription that was used for the transaction. ,
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 ,
}
,
}
,
]
,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
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 ,
}
,
]
,
}
,
}
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 2020-05-01. ,
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 2020-05-01. ,
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 2020-05-01. ,
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 2020-05-01. ,
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 2020-05-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A billing property. ,
Required: False ,
}
{
accountAdminNotificationEmailAddress:
{
Description: The email address on which the account admin gets all Azure notifications. ,
Required: False ,
}
string ,
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 ,
isAccountAdmin:
{
Description: Indicates whether user is the account admin. ,
Required: False ,
}
boolean ,
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 ,
}
,
]
,
}
,
}
BillingProperty_Update (new)
Description :  Updates the billing property of a subscription. Currently, cost center can be updated. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

PATCH:  /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 2020-05-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the update billing property operation. ,
Required: True ,
}
{
properties:
{
Description: A billing property. ,
Required: False ,
}
{
accountAdminNotificationEmailAddress:
{
Description: The email address on which the account admin gets all Azure notifications. ,
Required: False ,
}
string ,
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 ,
isAccountAdmin:
{
Description: Indicates whether user is the account admin. ,
Required: False ,
}
boolean ,
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 (200)

{
properties:
{
Description: A billing property. ,
Required: False ,
}
{
accountAdminNotificationEmailAddress:
{
Description: The email address on which the account admin gets all Azure notifications. ,
Required: False ,
}
string ,
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 ,
isAccountAdmin:
{
Description: Indicates whether user is the account admin. ,
Required: False ,
}
boolean ,
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 ,
}
,
]
,
}
,
}
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 2020-05-01. ,
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 2020-05-01. ,
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 2020-05-01. ,
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 ,
}
,
]
,
}
,
}
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 2020-05-01. ,
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 2020-05-01. ,
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 2020-05-01. ,
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_ListByBillingAccount (new)
Description :  Lists the role definitions for 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
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2020-05-01. ,
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 2020-05-01. ,
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 2020-05-01. ,
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 ,
}
,
]
,
}
,
}
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 or Microsoft Customer 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 2020-05-01. ,
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. ,
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 ,
userAuthenticationType:
{
Description: The authentication type. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user. ,
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 2020-05-01. ,
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. ,
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 ,
userAuthenticationType:
{
Description: The authentication type. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user. ,
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 2020-05-01. ,
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. ,
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 ,
userAuthenticationType:
{
Description: The authentication type. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user. ,
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 2020-05-01. ,
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. ,
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 ,
userAuthenticationType:
{
Description: The authentication type. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user. ,
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 2020-05-01. ,
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. ,
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 ,
userAuthenticationType:
{
Description: The authentication type. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user. ,
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 2020-05-01. ,
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. ,
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 ,
userAuthenticationType:
{
Description: The authentication type. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user. ,
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 or Microsoft Customer 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 2020-05-01. ,
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. ,
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 ,
userAuthenticationType:
{
Description: The authentication type. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user. ,
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 2020-05-01. ,
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. ,
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 ,
userAuthenticationType:
{
Description: The authentication type. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user. ,
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 2020-05-01. ,
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. ,
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 ,
userAuthenticationType:
{
Description: The authentication type. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user. ,
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 2020-05-01. ,
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:
{
Other: No description available. ,
ClickToAccept: No description available. ,
ESignEmbedded: No description available. ,
ESignOffline: No description available. ,
PhysicalSign: No description available. ,
Offline: No description available. ,
Implicit: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfileInfo:
{
Description: The list of billing profiles associated with agreement and present only for specific agreements. ,
Required: False ,
}
{
billingProfileId:
{
Description: The unique identifier for the billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile ,
Required: False ,
}
string ,
indirectRelationshipOrganizationName:
{
Description: Billing account name. This property is available for a specific type of agreement. ,
Required: False ,
}
string ,
}
,
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 2020-05-01. ,
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:
{
Other: No description available. ,
ClickToAccept: No description available. ,
ESignEmbedded: No description available. ,
ESignOffline: No description available. ,
PhysicalSign: No description available. ,
Offline: No description available. ,
Implicit: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfileInfo:
{
Description: The list of billing profiles associated with agreement and present only for specific agreements. ,
Required: False ,
}
{
billingProfileId:
{
Description: The unique identifier for the billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile ,
Required: False ,
}
string ,
indirectRelationshipOrganizationName:
{
Description: Billing account name. This property is available for a specific type of agreement. ,
Required: False ,
}
string ,
}
,
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 ,
}
,
]
,
}
,
}
Reservations_ListByBillingAccount (new)
Description :  Lists the reservations for a billing account and the roll up counts of reservations group by provisioning states.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservations
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2020-05-01. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter by reservation properties. The filter supports 'eq', 'or', and 'and'. It does not currently support 'ne', 'gt', 'le', 'ge', or 'not'. ,
Required: False ,
}
string ,
$orderby:
{
Description: May be used to sort order by reservation properties. ,
Required: False ,
}
string ,
refreshSummary:
{
Description: To indicate whether to refresh the roll up counts of the reservations group by provisioning states ,
Required: False ,
}
string ,
selectedState:
{
Description: The selected provisioning state ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservations. ,
Required: False ,
}
[
{
id:
{
Description: The id of the reservation. ,
Required: False ,
}
string ,
name:
{
Description: The name of the reservation. ,
Required: False ,
}
string ,
type:
{
Description: The type of the reservation. ,
Required: False ,
}
string ,
location:
{
Description: The location of the reservation. ,
Required: False ,
}
string ,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Description: The name of the reservation sku. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties associated to this reservation ,
Required: False ,
}
{
appliedScopes:
{
Description: The array of applied scopes of a reservation. Will be null if the reservation is in Shared scope ,
Required: False ,
}
[
string ,
]
,
appliedScopeType:
{
Description: The applied scope type of the reservation. ,
Required: False ,
}
string ,
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
quantity:
{
Description: The number of the reservation. ,
Required: False ,
}
number ,
provisioningState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
expiryDate:
{
Description: The expiry date of the reservation ,
Required: False ,
}
string ,
provisioningSubState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the reservation ,
Required: False ,
}
string ,
displayProvisioningState:
{
Description: The provisioning state of the reservation for display, e.g. Succeeded ,
Required: False ,
}
string ,
userFriendlyRenewState:
{
Description: The renew state of the reservation for display, e.g. On ,
Required: False ,
}
string ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the reservation for display, e.g. Shared ,
Required: False ,
}
string ,
effectiveDateTime:
{
Description: The effective date time of the reservation ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the reservation ,
Required: False ,
}
string ,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
renew:
{
Description: The renew state of the reservation ,
Required: False ,
}
boolean ,
renewSource:
{
Description: The renew source of the reservation ,
Required: False ,
}
string ,
utilization:
{
Description: Reservation utilization ,
Required: False ,
}
{
trend:
{
Description: The number of days trend for a reservation ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a reservation's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
summary:
{
Description: The roll out count summary of the reservations ,
Required: False ,
}
{
succeededCount:
{
Description: The number of reservation in Succeeded state ,
Required: False ,
}
number ,
failedCount:
{
Description: The number of reservation in Failed state ,
Required: False ,
}
number ,
expiringCount:
{
Description: The number of reservation in Expiring state ,
Required: False ,
}
number ,
expiredCount:
{
Description: The number of reservation in Expired state ,
Required: False ,
}
number ,
pendingCount:
{
Description: The number of reservation in Pending state ,
Required: False ,
}
number ,
cancelledCount:
{
Description: The number of reservation in Cancelled state ,
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 ,
}
,
]
,
}
,
}
Reservations_ListByBillingProfile (new)
Description :  Lists the reservations for a billing profile and the roll up counts of reservations group by provisioning state.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/reservations
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2020-05-01. ,
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 by reservation properties. The filter supports 'eq', 'or', and 'and'. It does not currently support 'ne', 'gt', 'le', 'ge', or 'not'. ,
Required: False ,
}
string ,
$orderby:
{
Description: May be used to sort order by reservation properties. ,
Required: False ,
}
string ,
refreshSummary:
{
Description: To indicate whether to refresh the roll up counts of the reservations group by provisioning state ,
Required: False ,
}
string ,
selectedState:
{
Description: The selected provisioning state ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservations. ,
Required: False ,
}
[
{
id:
{
Description: The id of the reservation. ,
Required: False ,
}
string ,
name:
{
Description: The name of the reservation. ,
Required: False ,
}
string ,
type:
{
Description: The type of the reservation. ,
Required: False ,
}
string ,
location:
{
Description: The location of the reservation. ,
Required: False ,
}
string ,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Description: The name of the reservation sku. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties associated to this reservation ,
Required: False ,
}
{
appliedScopes:
{
Description: The array of applied scopes of a reservation. Will be null if the reservation is in Shared scope ,
Required: False ,
}
[
string ,
]
,
appliedScopeType:
{
Description: The applied scope type of the reservation. ,
Required: False ,
}
string ,
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
quantity:
{
Description: The number of the reservation. ,
Required: False ,
}
number ,
provisioningState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
expiryDate:
{
Description: The expiry date of the reservation ,
Required: False ,
}
string ,
provisioningSubState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the reservation ,
Required: False ,
}
string ,
displayProvisioningState:
{
Description: The provisioning state of the reservation for display, e.g. Succeeded ,
Required: False ,
}
string ,
userFriendlyRenewState:
{
Description: The renew state of the reservation for display, e.g. On ,
Required: False ,
}
string ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the reservation for display, e.g. Shared ,
Required: False ,
}
string ,
effectiveDateTime:
{
Description: The effective date time of the reservation ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the reservation ,
Required: False ,
}
string ,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
renew:
{
Description: The renew state of the reservation ,
Required: False ,
}
boolean ,
renewSource:
{
Description: The renew source of the reservation ,
Required: False ,
}
string ,
utilization:
{
Description: Reservation utilization ,
Required: False ,
}
{
trend:
{
Description: The number of days trend for a reservation ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a reservation's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
summary:
{
Description: The roll out count summary of the reservations ,
Required: False ,
}
{
succeededCount:
{
Description: The number of reservation in Succeeded state ,
Required: False ,
}
number ,
failedCount:
{
Description: The number of reservation in Failed state ,
Required: False ,
}
number ,
expiringCount:
{
Description: The number of reservation in Expiring state ,
Required: False ,
}
number ,
expiredCount:
{
Description: The number of reservation in Expired state ,
Required: False ,
}
number ,
pendingCount:
{
Description: The number of reservation in Pending state ,
Required: False ,
}
number ,
cancelledCount:
{
Description: The number of reservation in Cancelled state ,
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 ,
}
,
]
,
}
,
}
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 2020-05-01. ,
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 ,
isDataAction:
{
Description: Identifies if the operation is a data operation. ,
Required: False ,
}
boolean ,
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 ,
description:
{
Description: Description of operation. ,
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 ,
}
,
}
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 2020-05-01. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the soldTo, 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 ,
soldTo:
{
Description: The address of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
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 ,
accountType:
{
Description: The type of customer. ,
Enum:
{
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatus:
{
Description: The current status of the billing account. ,
Enum:
{
Active: No description available. ,
Deleted: No description available. ,
Disabled: No description available. ,
Expired: No description available. ,
Transferred: No description available. ,
Extended: No description available. ,
Terminated: 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 ,
}
{
hasMoreResults:
{
Description: Indicates whether there are more billing profiles than the ones listed in this collection. The collection lists a maximum of 50 billing profiles. To get all billing profiles, use the list billing profiles API. ,
Required: False ,
}
boolean ,
value:
{
Description: The billing profiles associated with the billing account. ,
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 ,
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 ,
billTo:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
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 ,
}
,
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 ,
}
,
]
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
hasMoreResults:
{
Description: Indicates whether there are more invoice sections than the ones listed in this collection. The collection lists a maximum of 50 invoice sections. To get all invoice sections, use the list invoice sections API. ,
Required: False ,
}
boolean ,
value:
{
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 ,
labels:
{
Description: Dictionary of metadata associated with the invoice section. ,
Required: False ,
}
object ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the invoice section. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
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 ,
}
,
}
,
]
,
}
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing profile. ,
Required: False ,
}
boolean ,
systemId:
{
Description: The system generated unique identifier for a billing profile. ,
Required: False ,
}
string ,
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 ,
]
,
tags:
{
Description: Tags of billing profiles. ,
Required: False ,
}
object ,
}
,
}
,
]
,
}
,
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 ,
marketplaceEnabled:
{
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 ,
accountOwnerEmail:
{
Description: The enrollment account owner email address. ,
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 ,
accountOwnerEmail:
{
Description: The enrollment account owner email address. ,
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 ,
}
,
}
,
]
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing account. ,
Required: False ,
}
boolean ,
notificationEmailAddress:
{
Description: Notification email address, only for legacy accounts ,
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 2020-05-01. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the soldTo, 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 ,
soldTo:
{
Description: The address of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
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 ,
accountType:
{
Description: The type of customer. ,
Enum:
{
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatus:
{
Description: The current status of the billing account. ,
Enum:
{
Active: No description available. ,
Deleted: No description available. ,
Disabled: No description available. ,
Expired: No description available. ,
Transferred: No description available. ,
Extended: No description available. ,
Terminated: 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 ,
}
{
hasMoreResults:
{
Description: Indicates whether there are more billing profiles than the ones listed in this collection. The collection lists a maximum of 50 billing profiles. To get all billing profiles, use the list billing profiles API. ,
Required: False ,
}
boolean ,
value:
{
Description: The billing profiles associated with the billing account. ,
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 ,
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 ,
billTo:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
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 ,
}
,
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 ,
}
,
]
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
hasMoreResults:
{
Description: Indicates whether there are more invoice sections than the ones listed in this collection. The collection lists a maximum of 50 invoice sections. To get all invoice sections, use the list invoice sections API. ,
Required: False ,
}
boolean ,
value:
{
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 ,
labels:
{
Description: Dictionary of metadata associated with the invoice section. ,
Required: False ,
}
object ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the invoice section. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
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 ,
}
,
}
,
]
,
}
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing profile. ,
Required: False ,
}
boolean ,
systemId:
{
Description: The system generated unique identifier for a billing profile. ,
Required: False ,
}
string ,
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 ,
]
,
tags:
{
Description: Tags of billing profiles. ,
Required: False ,
}
object ,
}
,
}
,
]
,
}
,
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 ,
marketplaceEnabled:
{
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 ,
accountOwnerEmail:
{
Description: The enrollment account owner email address. ,
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 ,
accountOwnerEmail:
{
Description: The enrollment account owner email address. ,
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 ,
}
,
}
,
]
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing account. ,
Required: False ,
}
boolean ,
notificationEmailAddress:
{
Description: Notification email address, only for legacy accounts ,
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 2020-05-01. ,
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 ,
soldTo:
{
Description: The address of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
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 ,
accountType:
{
Description: The type of customer. ,
Enum:
{
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatus:
{
Description: The current status of the billing account. ,
Enum:
{
Active: No description available. ,
Deleted: No description available. ,
Disabled: No description available. ,
Expired: No description available. ,
Transferred: No description available. ,
Extended: No description available. ,
Terminated: 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 ,
}
{
hasMoreResults:
{
Description: Indicates whether there are more billing profiles than the ones listed in this collection. The collection lists a maximum of 50 billing profiles. To get all billing profiles, use the list billing profiles API. ,
Required: False ,
}
boolean ,
value:
{
Description: The billing profiles associated with the billing account. ,
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 ,
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 ,
billTo:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
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 ,
}
,
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 ,
}
,
]
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
hasMoreResults:
{
Description: Indicates whether there are more invoice sections than the ones listed in this collection. The collection lists a maximum of 50 invoice sections. To get all invoice sections, use the list invoice sections API. ,
Required: False ,
}
boolean ,
value:
{
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 ,
labels:
{
Description: Dictionary of metadata associated with the invoice section. ,
Required: False ,
}
object ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the invoice section. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
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 ,
}
,
}
,
]
,
}
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing profile. ,
Required: False ,
}
boolean ,
systemId:
{
Description: The system generated unique identifier for a billing profile. ,
Required: False ,
}
string ,
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 ,
]
,
tags:
{
Description: Tags of billing profiles. ,
Required: False ,
}
object ,
}
,
}
,
]
,
}
,
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 ,
marketplaceEnabled:
{
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 ,
accountOwnerEmail:
{
Description: The enrollment account owner email address. ,
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 ,
accountOwnerEmail:
{
Description: The enrollment account owner email address. ,
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 ,
}
,
}
,
]
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing account. ,
Required: False ,
}
boolean ,
notificationEmailAddress:
{
Description: Notification email address, only for legacy accounts ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the billing account. ,
Required: False ,
}
{
displayName:
{
Description: The billing account name. ,
Required: False ,
}
string ,
soldTo:
{
Description: The address of the individual or organization that is responsible for the billing account. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
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 ,
accountType:
{
Description: The type of customer. ,
Enum:
{
Enterprise: No description available. ,
Individual: No description available. ,
Partner: No description available. ,
}
,
Required: False ,
}
enum ,
accountStatus:
{
Description: The current status of the billing account. ,
Enum:
{
Active: No description available. ,
Deleted: No description available. ,
Disabled: No description available. ,
Expired: No description available. ,
Transferred: No description available. ,
Extended: No description available. ,
Terminated: 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 ,
}
{
hasMoreResults:
{
Description: Indicates whether there are more billing profiles than the ones listed in this collection. The collection lists a maximum of 50 billing profiles. To get all billing profiles, use the list billing profiles API. ,
Required: False ,
}
boolean ,
value:
{
Description: The billing profiles associated with the billing account. ,
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 ,
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 ,
billTo:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
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 ,
}
,
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 ,
}
,
]
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
hasMoreResults:
{
Description: Indicates whether there are more invoice sections than the ones listed in this collection. The collection lists a maximum of 50 invoice sections. To get all invoice sections, use the list invoice sections API. ,
Required: False ,
}
boolean ,
value:
{
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 ,
labels:
{
Description: Dictionary of metadata associated with the invoice section. ,
Required: False ,
}
object ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the invoice section. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
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 ,
}
,
}
,
]
,
}
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing profile. ,
Required: False ,
}
boolean ,
systemId:
{
Description: The system generated unique identifier for a billing profile. ,
Required: False ,
}
string ,
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 ,
]
,
tags:
{
Description: Tags of billing profiles. ,
Required: False ,
}
object ,
}
,
}
,
]
,
}
,
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 ,
marketplaceEnabled:
{
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 ,
accountOwnerEmail:
{
Description: The enrollment account owner email address. ,
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 ,
accountOwnerEmail:
{
Description: The enrollment account owner email address. ,
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 ,
}
,
}
,
]
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing account. ,
Required: False ,
}
boolean ,
notificationEmailAddress:
{
Description: Notification email address, only for legacy accounts ,
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 2020-05-01. ,
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 ,
invoiceSectionSystemId:
{
Description: The system generated unique identifier for an 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 ,
billingProfileSystemId:
{
Description: The system generated unique identifier for a billing profile. ,
Required: False ,
}
string ,
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 ,
}
,
]
,
}
,
}
Address_Validate (removed)
Description :  Validates an address. Use the operation to validate an address before using it as soldTo or a billTo 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 2020-05-01. ,
Required: True ,
}
string ,
address:
{
Required: True ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
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 ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
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_Get (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 2020-05-01. ,
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 2020-05-01. ,
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 2020-05-01. ,
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 2020-05-01. ,
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 ,
}
,
]
,
}
,
}
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 2020-05-01. ,
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 ,
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 ,
billTo:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
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 ,
}
,
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 ,
}
,
]
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
hasMoreResults:
{
Description: Indicates whether there are more invoice sections than the ones listed in this collection. The collection lists a maximum of 50 invoice sections. To get all invoice sections, use the list invoice sections API. ,
Required: False ,
}
boolean ,
value:
{
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 ,
labels:
{
Description: Dictionary of metadata associated with the invoice section. ,
Required: False ,
}
object ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the invoice section. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
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 ,
}
,
}
,
]
,
}
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing profile. ,
Required: False ,
}
boolean ,
systemId:
{
Description: The system generated unique identifier for a billing profile. ,
Required: False ,
}
string ,
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 ,
]
,
tags:
{
Description: Tags of billing profiles. ,
Required: False ,
}
object ,
}
,
}
,
]
,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
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 2020-05-01. ,
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 ,
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 ,
billTo:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
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 ,
}
,
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 ,
}
,
]
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
hasMoreResults:
{
Description: Indicates whether there are more invoice sections than the ones listed in this collection. The collection lists a maximum of 50 invoice sections. To get all invoice sections, use the list invoice sections API. ,
Required: False ,
}
boolean ,
value:
{
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 ,
labels:
{
Description: Dictionary of metadata associated with the invoice section. ,
Required: False ,
}
object ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the invoice section. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
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 ,
}
,
}
,
]
,
}
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing profile. ,
Required: False ,
}
boolean ,
systemId:
{
Description: The system generated unique identifier for a billing profile. ,
Required: False ,
}
string ,
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 ,
]
,
tags:
{
Description: Tags of billing profiles. ,
Required: False ,
}
object ,
}
,
}

⚐ 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_CreateOrUpdate (removed)
Description :  Creates or updates 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 2020-05-01. ,
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: The new or updated billing profile. ,
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 ,
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 ,
billTo:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
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 ,
}
,
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 ,
}
,
]
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
hasMoreResults:
{
Description: Indicates whether there are more invoice sections than the ones listed in this collection. The collection lists a maximum of 50 invoice sections. To get all invoice sections, use the list invoice sections API. ,
Required: False ,
}
boolean ,
value:
{
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 ,
labels:
{
Description: Dictionary of metadata associated with the invoice section. ,
Required: False ,
}
object ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the invoice section. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
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 ,
}
,
}
,
]
,
}
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing profile. ,
Required: False ,
}
boolean ,
systemId:
{
Description: The system generated unique identifier for a billing profile. ,
Required: False ,
}
string ,
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 ,
]
,
tags:
{
Description: Tags of billing profiles. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ 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 ,
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 ,
billTo:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
middleName:
{
Description: Middle name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address line 1. ,
Required: True ,
}
string ,
addressLine2:
{
Description: Address line 2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address line 3. ,
Required: False ,
}
string ,
city:
{
Description: Address city. ,
Required: False ,
}
string ,
district:
{
Description: Address district. ,
Required: False ,
}
string ,
region:
{
Description: Address region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: True ,
}
string ,
postalCode:
{
Description: Postal code. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
phoneNumber:
{
Description: Phone number. ,
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 ,
}
,
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 ,
}
,
]
,
invoiceSections:
{
Description: The invoice sections associated to the billing profile. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
hasMoreResults:
{
Description: Indicates whether there are more invoice sections than the ones listed in this collection. The collection lists a maximum of 50 invoice sections. To get all invoice sections, use the list invoice sections API. ,
Required: False ,
}
boolean ,
value:
{
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 ,
labels:
{
Description: Dictionary of metadata associated with the invoice section. ,
Required: False ,
}
object ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the invoice section. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
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 ,
}
,
}
,
]
,
}
,
hasReadAccess:
{
Description: Indicates whether user has read access to the billing profile. ,
Required: False ,
}
boolean ,
systemId:
{
Description: The system generated unique identifier for a billing profile. ,
Required: False ,
}
string ,
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 ,
]
,
tags:
{
Description: Tags of billing profiles. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
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 2020-05-01. ,
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 ,
$search:
{
Description: Used for searching customers by their name. Any customer with name containing the search text will be included in the response ,
Required: False ,
}
string ,
$filter:
{
Description: May be used to filter the list of customers. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of customers. ,
Required: False ,
}
[
{
properties:
{
Description: The customer. ,
Required: False ,
}
{
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 ,
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 ,
}
,
]
,
}
,
}
,
]
,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
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 2020-05-01. ,
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 ,
labels:
{
Description: Dictionary of metadata associated with the invoice section. ,
Required: False ,
}
object ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the invoice section. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
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 ,
}
,
}
,
]
,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
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 2020-05-01. ,
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 ,
labels:
{
Description: Dictionary of metadata associated with the invoice section. ,
Required: False ,
}
object ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the invoice section. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
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_CreateOrUpdate (removed)
Description :  Creates or updates 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 2020-05-01. ,
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: The new or updated invoice section. ,
Required: True ,
}
{
properties:
{
Description: The properties of an invoice section. ,
Required: False ,
}
{
displayName:
{
Description: The name of the invoice section. ,
Required: False ,
}
string ,
labels:
{
Description: Dictionary of metadata associated with the invoice section. ,
Required: False ,
}
object ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the invoice section. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
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 ,
labels:
{
Description: Dictionary of metadata associated with the invoice section. ,
Required: False ,
}
object ,
state:
{
Description: Identifies the state of an invoice section. ,
Enum:
{
Active: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
systemId:
{
Description: The system generated unique identifier for an invoice section. ,
Required: False ,
}
string ,
tags:
{
Description: Dictionary of metadata associated with the invoice section. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / ,
Required: False ,
}
object ,
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 ,
}
,
]
,
}
,
}
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 2020-05-01. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
$search:
{
Description: Used for searching customers by their name. Any customer with name containing the search text will be included in the response ,
Required: False ,
}
string ,
$filter:
{
Description: May be used to filter the list of customers. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of customers. ,
Required: False ,
}
[
{
properties:
{
Description: The customer. ,
Required: False ,
}
{
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 ,
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 ,
}
,
]
,
}
,
}
,
]
,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
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 2020-05-01. ,
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 ,
}
{
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 ,
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 2020-05-01. ,
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 2020-05-01. ,
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 ,
costCenter:
{
Description: The cost center applied to the subscription. ,
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 ,
suspensionReasons:
{
Description: The suspension reason for a subscription. Applies only to subscriptions in Microsoft Online Services Program billing accounts. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
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_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 2020-05-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of products. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a product. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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 ,
}
,
}
,
}
,
]
,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
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_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 or Microsoft Customer 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 2020-05-01. ,
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 ,
source:
{
Description: The source of the document. ENF for Brazil and DRS for rest of the world. ,
Enum:
{
DRS: No description available. ,
ENF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
rebillDetails:
{
Description: Rebill details for an invoice. ,
Required: False ,
}
object ,
documentType:
{
Description: The type of the document. ,
Enum:
{
Invoice: No description available. ,
CreditNote: No description available. ,
}
,
Required: False ,
}
enum ,
billedDocumentId:
{
Description: The Id of the active invoice which is originally billed after this invoice was voided. This field is applicable to the void invoices only. ,
Required: False ,
}
string ,
creditForDocumentId:
{
Description: The Id of the invoice which got voided and this credit note was issued as a result. This field is applicable to the credit notes only. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
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_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 2020-05-01. ,
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 ,
source:
{
Description: The source of the document. ENF for Brazil and DRS for rest of the world. ,
Enum:
{
DRS: No description available. ,
ENF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
rebillDetails:
{
Description: Rebill details for an invoice. ,
Required: False ,
}
object ,
documentType:
{
Description: The type of the document. ,
Enum:
{
Invoice: No description available. ,
CreditNote: No description available. ,
}
,
Required: False ,
}
enum ,
billedDocumentId:
{
Description: The Id of the active invoice which is originally billed after this invoice was voided. This field is applicable to the void invoices only. ,
Required: False ,
}
string ,
creditForDocumentId:
{
Description: The Id of the invoice which got voided and this credit note was issued as a result. This field is applicable to the credit notes only. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
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_Get (removed)
Description :  Gets an invoice by billing account name and 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}/invoices/{invoiceName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2020-05-01. ,
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 ,
source:
{
Description: The source of the document. ENF for Brazil and DRS for rest of the world. ,
Enum:
{
DRS: No description available. ,
ENF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
rebillDetails:
{
Description: Rebill details for an invoice. ,
Required: False ,
}
object ,
documentType:
{
Description: The type of the document. ,
Enum:
{
Invoice: No description available. ,
CreditNote: No description available. ,
}
,
Required: False ,
}
enum ,
billedDocumentId:
{
Description: The Id of the active invoice which is originally billed after this invoice was voided. This field is applicable to the void invoices only. ,
Required: False ,
}
string ,
creditForDocumentId:
{
Description: The Id of the invoice which got voided and this credit note was issued as a result. This field is applicable to the credit notes only. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
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_GetById (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/default/invoices/{invoiceName}
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2020-05-01. ,
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 ,
source:
{
Description: The source of the document. ENF for Brazil and DRS for rest of the world. ,
Enum:
{
DRS: No description available. ,
ENF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
rebillDetails:
{
Description: Rebill details for an invoice. ,
Required: False ,
}
object ,
documentType:
{
Description: The type of the document. ,
Enum:
{
Invoice: No description available. ,
CreditNote: No description available. ,
}
,
Required: False ,
}
enum ,
billedDocumentId:
{
Description: The Id of the active invoice which is originally billed after this invoice was voided. This field is applicable to the void invoices only. ,
Required: False ,
}
string ,
creditForDocumentId:
{
Description: The Id of the invoice which got voided and this credit note was issued as a result. This field is applicable to the credit notes only. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
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_DownloadInvoice (removed)
Description :  Gets a URL to download 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}/invoices/{invoiceName}/download
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2020-05-01. ,
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 ,
downloadToken:
{
Description: Download token with document source and document ID. ,
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_DownloadMultipleBillingProfileInvoices (removed)
Description :  Gets a URL to download multiple invoice documents (invoice pdf, tax receipts, credit notes) as a zip file. 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}/downloadDocuments
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2020-05-01. ,
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 ,
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 ,
}
,
]
,
}
,
}
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 2020-05-01. ,
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 ,
costCenter:
{
Description: The cost center applied to the subscription. ,
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 ,
suspensionReasons:
{
Description: The suspension reason for a subscription. Applies only to subscriptions in Microsoft Online Services Program billing accounts. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
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/default/billingSubscriptions/{subscriptionId}/invoices
{
subscriptionId:
{
Description: The ID that uniquely identifies an Azure 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 2020-05-01. ,
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 ,
source:
{
Description: The source of the document. ENF for Brazil and DRS for rest of the world. ,
Enum:
{
DRS: No description available. ,
ENF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
rebillDetails:
{
Description: Rebill details for an invoice. ,
Required: False ,
}
object ,
documentType:
{
Description: The type of the document. ,
Enum:
{
Invoice: No description available. ,
CreditNote: No description available. ,
}
,
Required: False ,
}
enum ,
billedDocumentId:
{
Description: The Id of the active invoice which is originally billed after this invoice was voided. This field is applicable to the void invoices only. ,
Required: False ,
}
string ,
creditForDocumentId:
{
Description: The Id of the invoice which got voided and this credit note was issued as a result. This field is applicable to the credit notes only. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
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_GetBySubscriptionAndInvoiceId (removed)
Description :  Gets an invoice by subscription ID and invoice ID.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/invoices/{invoiceName}
{
subscriptionId:
{
Description: The ID that uniquely identifies an Azure 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 2020-05-01. ,
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 ,
source:
{
Description: The source of the document. ENF for Brazil and DRS for rest of the world. ,
Enum:
{
DRS: No description available. ,
ENF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
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 ,
}
,
]
,
rebillDetails:
{
Description: Rebill details for an invoice. ,
Required: False ,
}
object ,
documentType:
{
Description: The type of the document. ,
Enum:
{
Invoice: No description available. ,
CreditNote: No description available. ,
}
,
Required: False ,
}
enum ,
billedDocumentId:
{
Description: The Id of the active invoice which is originally billed after this invoice was voided. This field is applicable to the void invoices only. ,
Required: False ,
}
string ,
creditForDocumentId:
{
Description: The Id of the invoice which got voided and this credit note was issued as a result. This field is applicable to the credit notes only. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the subscription for which the invoice is generated. ,
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_DownloadBillingSubscriptionInvoice (removed)
Description :  Gets a URL to download an invoice.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/invoices/{invoiceName}/download
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2020-05-01. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID that uniquely identifies an Azure subscription. ,
Required: True ,
}
string ,
invoiceName:
{
Description: The ID that uniquely identifies an invoice. ,
Required: True ,
}
string ,
downloadToken:
{
Description: Download token with document source and document ID. ,
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_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 2020-05-01. ,
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 ,
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 ,
}
,
]
,
}
,
}
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 2020-05-01. ,
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 ,
costCenter:
{
Description: The cost center applied to the subscription. ,
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 ,
suspensionReasons:
{
Description: The suspension reason for a subscription. Applies only to subscriptions in Microsoft Online Services Program billing accounts. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
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 2020-05-01. ,
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 ,
costCenter:
{
Description: The cost center applied to the subscription. ,
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 ,
suspensionReasons:
{
Description: The suspension reason for a subscription. Applies only to subscriptions in Microsoft Online Services Program billing accounts. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
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 for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{subscriptionId}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
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 2020-05-01. ,
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 ,
costCenter:
{
Description: The cost center applied to the subscription. ,
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 ,
suspensionReasons:
{
Description: The suspension reason for a subscription. Applies only to subscriptions in Microsoft Online Services Program billing accounts. ,
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_Update (removed)
Description :  Updates the properties of a billing subscription. Currently, cost center 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}/billingSubscriptions/{subscriptionId}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
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 2020-05-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the update billing subscription operation. ,
Required: True ,
}
{
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 ,
costCenter:
{
Description: The cost center applied to the subscription. ,
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 ,
suspensionReasons:
{
Description: The suspension reason for a subscription. Applies only to subscriptions in Microsoft Online Services Program billing accounts. ,
Required: False ,
}
[
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 ,
costCenter:
{
Description: The cost center applied to the subscription. ,
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 ,
suspensionReasons:
{
Description: The suspension reason for a subscription. Applies only to subscriptions in Microsoft Online Services Program billing accounts. ,
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_Move (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 for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{subscriptionId}/move
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
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 2020-05-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the move subscription operation. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
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 ,
costCenter:
{
Description: The cost center applied to the subscription. ,
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 ,
suspensionReasons:
{
Description: The suspension reason for a subscription. Applies only to subscriptions in Microsoft Online Services Program billing accounts. ,
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_ValidateMove (removed)
Description :  Validates if a subscription's charges can be moved to a new invoice section. This operation is supported for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{subscriptionId}/validateMoveEligibility
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
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 2020-05-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the validate move eligibility operation. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
isMoveEligible:
{
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 2020-05-01. ,
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 ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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 ,
}
,
}
,
}
,
]
,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
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_ListByBillingProfile (removed)
Description :  Lists the products for a billing profile. 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}/billingProfiles/{billingProfileName}/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 ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2020-05-01. ,
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 ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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 ,
}
,
}
,
}
,
]
,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
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 2020-05-01. ,
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 ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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 ,
}
,
}
,
}
,
]
,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
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}/products/{productName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
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 2020-05-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a product. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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_Update (removed)
Description :  Updates the properties of a Product. Currently, auto renew 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}/products/{productName}
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
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 2020-05-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the update product operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of a product. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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 (200)

{
properties:
{
Description: The properties of a product. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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_Move (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}/products/{productName}/move
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
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 2020-05-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the move product operation. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a product. ,
Required: False ,
}
{
autoRenew:
{
Description: Indicates whether auto renewal is turned on or off for a product. ,
Enum:
{
Off: No description available. ,
On: No description available. ,
}
,
Required: False ,
}
enum ,
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 ,
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_ValidateMove (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}/products/{productName}/validateMoveEligibility
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
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 2020-05-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the validate move eligibility operation. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
isMoveEligible:
{
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_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}/invoices/{invoiceName}/transactions
{
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 ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2020-05-01. ,
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 ,
invoiceId:
{
Description: The ID of the invoice on which the transaction was billed. This field is only applicable for transactions which are 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 ,
azurePlan:
{
Description: The type of azure plan of the subscription that was used for the transaction. ,
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 ,
}
,
}
,
]
,
totalCount:
{
Description: Total number of records. ,
Format: int32 ,
Required: False ,
}
number ,
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 ,
}
,
]
,
}
,
}
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 2020-05-01. ,
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 2020-05-01. ,
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 2020-05-01. ,
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 2020-05-01. ,
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 2020-05-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A billing property. ,
Required: False ,
}
{
accountAdminNotificationEmailAddress:
{
Description: The email address on which the account admin gets all Azure notifications. ,
Required: False ,
}
string ,
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 ,
isAccountAdmin:
{
Description: Indicates whether user is the account admin. ,
Required: False ,
}
boolean ,
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 ,
}
,
]
,
}
,
}
BillingProperty_Update (removed)
Description :  Updates the billing property of a subscription. Currently, cost center can be updated. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
Reference :  Link ¶

⚼ Request

PATCH:  /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 2020-05-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to the update billing property operation. ,
Required: True ,
}
{
properties:
{
Description: A billing property. ,
Required: False ,
}
{
accountAdminNotificationEmailAddress:
{
Description: The email address on which the account admin gets all Azure notifications. ,
Required: False ,
}
string ,
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 ,
isAccountAdmin:
{
Description: Indicates whether user is the account admin. ,
Required: False ,
}
boolean ,
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 (200)

{
properties:
{
Description: A billing property. ,
Required: False ,
}
{
accountAdminNotificationEmailAddress:
{
Description: The email address on which the account admin gets all Azure notifications. ,
Required: False ,
}
string ,
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 ,
isAccountAdmin:
{
Description: Indicates whether user is the account admin. ,
Required: False ,
}
boolean ,
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 ,
}
,
]
,
}
,
}
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 2020-05-01. ,
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 2020-05-01. ,
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 2020-05-01. ,
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 ,
}
,
]
,
}
,
}
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 2020-05-01. ,
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 2020-05-01. ,
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 2020-05-01. ,
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_ListByBillingAccount (removed)
Description :  Lists the role definitions for 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
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2020-05-01. ,
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 2020-05-01. ,
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 2020-05-01. ,
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 ,
}
,
]
,
}
,
}
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 or Microsoft Customer 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 2020-05-01. ,
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. ,
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 ,
userAuthenticationType:
{
Description: The authentication type. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user. ,
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 2020-05-01. ,
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. ,
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 ,
userAuthenticationType:
{
Description: The authentication type. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user. ,
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 2020-05-01. ,
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. ,
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 ,
userAuthenticationType:
{
Description: The authentication type. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user. ,
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 2020-05-01. ,
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. ,
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 ,
userAuthenticationType:
{
Description: The authentication type. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user. ,
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 2020-05-01. ,
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. ,
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 ,
userAuthenticationType:
{
Description: The authentication type. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user. ,
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 2020-05-01. ,
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. ,
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 ,
userAuthenticationType:
{
Description: The authentication type. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user. ,
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 or Microsoft Customer 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 2020-05-01. ,
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. ,
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 ,
userAuthenticationType:
{
Description: The authentication type. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user. ,
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 2020-05-01. ,
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. ,
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 ,
userAuthenticationType:
{
Description: The authentication type. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user. ,
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 2020-05-01. ,
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. ,
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 ,
userAuthenticationType:
{
Description: The authentication type. ,
Required: False ,
}
string ,
userEmailAddress:
{
Description: The email address of the user. ,
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 2020-05-01. ,
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:
{
Other: No description available. ,
ClickToAccept: No description available. ,
ESignEmbedded: No description available. ,
ESignOffline: No description available. ,
PhysicalSign: No description available. ,
Offline: No description available. ,
Implicit: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfileInfo:
{
Description: The list of billing profiles associated with agreement and present only for specific agreements. ,
Required: False ,
}
{
billingProfileId:
{
Description: The unique identifier for the billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile ,
Required: False ,
}
string ,
indirectRelationshipOrganizationName:
{
Description: Billing account name. This property is available for a specific type of agreement. ,
Required: False ,
}
string ,
}
,
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 2020-05-01. ,
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:
{
Other: No description available. ,
ClickToAccept: No description available. ,
ESignEmbedded: No description available. ,
ESignOffline: No description available. ,
PhysicalSign: No description available. ,
Offline: No description available. ,
Implicit: No description available. ,
}
,
Required: False ,
}
enum ,
billingProfileInfo:
{
Description: The list of billing profiles associated with agreement and present only for specific agreements. ,
Required: False ,
}
{
billingProfileId:
{
Description: The unique identifier for the billing profile. ,
Required: False ,
}
string ,
billingProfileDisplayName:
{
Description: The name of the billing profile ,
Required: False ,
}
string ,
indirectRelationshipOrganizationName:
{
Description: Billing account name. This property is available for a specific type of agreement. ,
Required: False ,
}
string ,
}
,
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 ,
}
,
]
,
}
,
}
Reservations_ListByBillingAccount (removed)
Description :  Lists the reservations for a billing account and the roll up counts of reservations group by provisioning states.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservations
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2020-05-01. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter by reservation properties. The filter supports 'eq', 'or', and 'and'. It does not currently support 'ne', 'gt', 'le', 'ge', or 'not'. ,
Required: False ,
}
string ,
$orderby:
{
Description: May be used to sort order by reservation properties. ,
Required: False ,
}
string ,
refreshSummary:
{
Description: To indicate whether to refresh the roll up counts of the reservations group by provisioning states ,
Required: False ,
}
string ,
selectedState:
{
Description: The selected provisioning state ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservations. ,
Required: False ,
}
[
{
id:
{
Description: The id of the reservation. ,
Required: False ,
}
string ,
name:
{
Description: The name of the reservation. ,
Required: False ,
}
string ,
type:
{
Description: The type of the reservation. ,
Required: False ,
}
string ,
location:
{
Description: The location of the reservation. ,
Required: False ,
}
string ,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Description: The name of the reservation sku. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties associated to this reservation ,
Required: False ,
}
{
appliedScopes:
{
Description: The array of applied scopes of a reservation. Will be null if the reservation is in Shared scope ,
Required: False ,
}
[
string ,
]
,
appliedScopeType:
{
Description: The applied scope type of the reservation. ,
Required: False ,
}
string ,
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
quantity:
{
Description: The number of the reservation. ,
Required: False ,
}
number ,
provisioningState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
expiryDate:
{
Description: The expiry date of the reservation ,
Required: False ,
}
string ,
provisioningSubState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the reservation ,
Required: False ,
}
string ,
displayProvisioningState:
{
Description: The provisioning state of the reservation for display, e.g. Succeeded ,
Required: False ,
}
string ,
userFriendlyRenewState:
{
Description: The renew state of the reservation for display, e.g. On ,
Required: False ,
}
string ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the reservation for display, e.g. Shared ,
Required: False ,
}
string ,
effectiveDateTime:
{
Description: The effective date time of the reservation ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the reservation ,
Required: False ,
}
string ,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
renew:
{
Description: The renew state of the reservation ,
Required: False ,
}
boolean ,
renewSource:
{
Description: The renew source of the reservation ,
Required: False ,
}
string ,
utilization:
{
Description: Reservation utilization ,
Required: False ,
}
{
trend:
{
Description: The number of days trend for a reservation ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a reservation's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
summary:
{
Description: The roll out count summary of the reservations ,
Required: False ,
}
{
succeededCount:
{
Description: The number of reservation in Succeeded state ,
Required: False ,
}
number ,
failedCount:
{
Description: The number of reservation in Failed state ,
Required: False ,
}
number ,
expiringCount:
{
Description: The number of reservation in Expiring state ,
Required: False ,
}
number ,
expiredCount:
{
Description: The number of reservation in Expired state ,
Required: False ,
}
number ,
pendingCount:
{
Description: The number of reservation in Pending state ,
Required: False ,
}
number ,
cancelledCount:
{
Description: The number of reservation in Cancelled state ,
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 ,
}
,
]
,
}
,
}
Reservations_ListByBillingProfile (removed)
Description :  Lists the reservations for a billing profile and the roll up counts of reservations group by provisioning state.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/reservations
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2020-05-01. ,
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 by reservation properties. The filter supports 'eq', 'or', and 'and'. It does not currently support 'ne', 'gt', 'le', 'ge', or 'not'. ,
Required: False ,
}
string ,
$orderby:
{
Description: May be used to sort order by reservation properties. ,
Required: False ,
}
string ,
refreshSummary:
{
Description: To indicate whether to refresh the roll up counts of the reservations group by provisioning state ,
Required: False ,
}
string ,
selectedState:
{
Description: The selected provisioning state ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservations. ,
Required: False ,
}
[
{
id:
{
Description: The id of the reservation. ,
Required: False ,
}
string ,
name:
{
Description: The name of the reservation. ,
Required: False ,
}
string ,
type:
{
Description: The type of the reservation. ,
Required: False ,
}
string ,
location:
{
Description: The location of the reservation. ,
Required: False ,
}
string ,
sku:
{
Description: The sku information associated to this reservation ,
Required: False ,
}
{
name:
{
Description: The name of the reservation sku. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties associated to this reservation ,
Required: False ,
}
{
appliedScopes:
{
Description: The array of applied scopes of a reservation. Will be null if the reservation is in Shared scope ,
Required: False ,
}
[
string ,
]
,
appliedScopeType:
{
Description: The applied scope type of the reservation. ,
Required: False ,
}
string ,
reservedResourceType:
{
Description: The reserved source type of the reservation, e.g. virtual machine. ,
Required: False ,
}
string ,
quantity:
{
Description: The number of the reservation. ,
Required: False ,
}
number ,
provisioningState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
expiryDate:
{
Description: The expiry date of the reservation ,
Required: False ,
}
string ,
provisioningSubState:
{
Description: The provisioning state of the reservation, e.g. Succeeded ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the reservation ,
Required: False ,
}
string ,
displayProvisioningState:
{
Description: The provisioning state of the reservation for display, e.g. Succeeded ,
Required: False ,
}
string ,
userFriendlyRenewState:
{
Description: The renew state of the reservation for display, e.g. On ,
Required: False ,
}
string ,
userFriendlyAppliedScopeType:
{
Description: The applied scope type of the reservation for display, e.g. Shared ,
Required: False ,
}
string ,
effectiveDateTime:
{
Description: The effective date time of the reservation ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description of the reservation ,
Required: False ,
}
string ,
term:
{
Description: The term of the reservation, e.g. P1Y ,
Required: False ,
}
string ,
renew:
{
Description: The renew state of the reservation ,
Required: False ,
}
boolean ,
renewSource:
{
Description: The renew source of the reservation ,
Required: False ,
}
string ,
utilization:
{
Description: Reservation utilization ,
Required: False ,
}
{
trend:
{
Description: The number of days trend for a reservation ,
Required: False ,
}
string ,
aggregates:
{
Description: The array of aggregates of a reservation's utilization ,
Required: False ,
}
[
{
grain:
{
Description: The grain of the aggregate ,
Required: False ,
}
number ,
grainUnit:
{
Description: The grain unit of the aggregate ,
Required: False ,
}
string ,
value:
{
Description: The aggregate value ,
Required: False ,
}
number ,
valueUnit:
{
Description: The aggregate value unit ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
summary:
{
Description: The roll out count summary of the reservations ,
Required: False ,
}
{
succeededCount:
{
Description: The number of reservation in Succeeded state ,
Required: False ,
}
number ,
failedCount:
{
Description: The number of reservation in Failed state ,
Required: False ,
}
number ,
expiringCount:
{
Description: The number of reservation in Expiring state ,
Required: False ,
}
number ,
expiredCount:
{
Description: The number of reservation in Expired state ,
Required: False ,
}
number ,
pendingCount:
{
Description: The number of reservation in Pending state ,
Required: False ,
}
number ,
cancelledCount:
{
Description: The number of reservation in Cancelled state ,
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 ,
}
,
]
,
}
,
}
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 2020-05-01. ,
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 ,
isDataAction:
{
Description: Identifies if the operation is a data operation. ,
Required: False ,
}
boolean ,
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 ,
description:
{
Description: Description of operation. ,
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 ,
}
,
}