Microsoft.Billing (preview:2018-11-01)

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

BillingAccounts_List (new)
Description :  Lists all billing accounts for which a user has access.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the invoiceSections and billingProfiles. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing accounts. ,
Required: False ,
}
[
{
properties:
{
Description: A billing account. ,
Required: False ,
}
{
displayName:
{
Description: The billing account name. ,
Required: False ,
}
string ,
accountType:
{
Description: The billing account Type. ,
Enum:
{
Organization: No description available. ,
Enrollment: No description available. ,
}
,
Required: False ,
}
enum ,
address:
{
Description: The address associated with billing account. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
company:
{
Description: Company Name. ,
Required: False ,
}
string ,
country:
{
Description: Country Name. ,
Required: False ,
}
string ,
invoiceSections:
{
Description: The invoice sections associated to the billing account. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: The InvoiceSection. ,
Required: False ,
}
{
displayName:
{
Description: The name of the InvoiceSection. ,
Required: False ,
}
string ,
billingProfiles:
{
Description: The billing profiles associated to the billing account. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
billingProfiles:
{
Description: The billing profiles associated to the billing account. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
enrollmentDetails:
{
Description: The details about the associated legacy enrollment. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
startDate:
{
Description: Enrollment Start Date ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Enrollment End Date ,
Format: date-time ,
Required: False ,
}
string ,
currency:
{
Description: The currency associated with enrollment ,
Required: False ,
}
string ,
channel:
{
Description: The channel for Enrollment ,
Required: False ,
}
string ,
policies:
{
Description: The attributes associated with legacy enrollment. ,
Required: False ,
}
{
accountOwnerViewCharges:
{
Description: The accountOwnerViewCharges flag for Enrollment ,
Required: False ,
}
boolean ,
departmentAdminViewCharges:
{
Description: The departmentAdminViewCharges flag for Enrollment ,
Required: False ,
}
boolean ,
marketplacesEnabled:
{
Description: The marketplaces flag for Enrollment ,
Required: False ,
}
boolean ,
reservedInstancesEnabled:
{
Description: The reserved instances flag for Enrollment ,
Required: False ,
}
boolean ,
}
,
language:
{
Description: The language for Enrollment ,
Required: False ,
}
string ,
countryCode:
{
Description: The countryCode for Enrollment ,
Required: False ,
}
string ,
status:
{
Description: Enrollment status ,
Required: False ,
}
string ,
billingCycle:
{
Description: Enrollment billing cycle ,
Required: False ,
}
string ,
}
,
departments:
{
Description: The departments associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: A department. ,
Required: False ,
}
{
departmentName:
{
Description: The name for department. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
status:
{
Description: The status for 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: An account. ,
Required: False ,
}
{
accountName:
{
Description: The account name. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The account owner ,
Required: False ,
}
string ,
status:
{
Description: The status for account. ,
Required: False ,
}
string ,
startDate:
{
Description: Account Start Date ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Account End Date ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
enrollmentAccounts:
{
Description: The accounts associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: An account. ,
Required: False ,
}
{
accountName:
{
Description: The account name. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The account owner ,
Required: False ,
}
string ,
status:
{
Description: The status for account. ,
Required: False ,
}
string ,
startDate:
{
Description: Account Start Date ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Account End Date ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
hasReadAccess:
{
Description: Specifies whether the user has read access on billing account. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
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 ,
}
,
}
BillingAccounts_Get (new)
Description :  Get the billing account by id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the invoiceSections and billingProfiles. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A billing account. ,
Required: False ,
}
{
displayName:
{
Description: The billing account name. ,
Required: False ,
}
string ,
accountType:
{
Description: The billing account Type. ,
Enum:
{
Organization: No description available. ,
Enrollment: No description available. ,
}
,
Required: False ,
}
enum ,
address:
{
Description: The address associated with billing account. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
company:
{
Description: Company Name. ,
Required: False ,
}
string ,
country:
{
Description: Country Name. ,
Required: False ,
}
string ,
invoiceSections:
{
Description: The invoice sections associated to the billing account. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: The InvoiceSection. ,
Required: False ,
}
{
displayName:
{
Description: The name of the InvoiceSection. ,
Required: False ,
}
string ,
billingProfiles:
{
Description: The billing profiles associated to the billing account. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
billingProfiles:
{
Description: The billing profiles associated to the billing account. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
enrollmentDetails:
{
Description: The details about the associated legacy enrollment. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
startDate:
{
Description: Enrollment Start Date ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Enrollment End Date ,
Format: date-time ,
Required: False ,
}
string ,
currency:
{
Description: The currency associated with enrollment ,
Required: False ,
}
string ,
channel:
{
Description: The channel for Enrollment ,
Required: False ,
}
string ,
policies:
{
Description: The attributes associated with legacy enrollment. ,
Required: False ,
}
{
accountOwnerViewCharges:
{
Description: The accountOwnerViewCharges flag for Enrollment ,
Required: False ,
}
boolean ,
departmentAdminViewCharges:
{
Description: The departmentAdminViewCharges flag for Enrollment ,
Required: False ,
}
boolean ,
marketplacesEnabled:
{
Description: The marketplaces flag for Enrollment ,
Required: False ,
}
boolean ,
reservedInstancesEnabled:
{
Description: The reserved instances flag for Enrollment ,
Required: False ,
}
boolean ,
}
,
language:
{
Description: The language for Enrollment ,
Required: False ,
}
string ,
countryCode:
{
Description: The countryCode for Enrollment ,
Required: False ,
}
string ,
status:
{
Description: Enrollment status ,
Required: False ,
}
string ,
billingCycle:
{
Description: Enrollment billing cycle ,
Required: False ,
}
string ,
}
,
departments:
{
Description: The departments associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: A department. ,
Required: False ,
}
{
departmentName:
{
Description: The name for department. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
status:
{
Description: The status for 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: An account. ,
Required: False ,
}
{
accountName:
{
Description: The account name. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The account owner ,
Required: False ,
}
string ,
status:
{
Description: The status for account. ,
Required: False ,
}
string ,
startDate:
{
Description: Account Start Date ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Account End Date ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
enrollmentAccounts:
{
Description: The accounts associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: An account. ,
Required: False ,
}
{
accountName:
{
Description: The account name. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The account owner ,
Required: False ,
}
string ,
status:
{
Description: The status for account. ,
Required: False ,
}
string ,
startDate:
{
Description: Account Start Date ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Account End Date ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
hasReadAccess:
{
Description: Specifies whether the user has read access on billing account. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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 :  The operation to update a billing account.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the update billing account operation. ,
Required: True ,
}
{
properties:
{
Description: A billing property. ,
Required: False ,
}
{
displayName:
{
Description: The billing account name. ,
Required: False ,
}
string ,
accountType:
{
Description: The billing account Type. ,
Enum:
{
Organization: No description available. ,
Enrollment: No description available. ,
}
,
Required: False ,
}
enum ,
address:
{
Description: The address associated with billing account. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
company:
{
Description: Company Name. ,
Required: False ,
}
string ,
country:
{
Description: Country Name. ,
Required: False ,
}
string ,
invoiceSections:
{
Description: The invoice sections associated to the billing account. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: The InvoiceSection. ,
Required: False ,
}
{
displayName:
{
Description: The name of the InvoiceSection. ,
Required: False ,
}
string ,
billingProfiles:
{
Description: The billing profiles associated to the billing account. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
billingProfiles:
{
Description: The billing profiles associated to the billing account. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
enrollmentDetails:
{
Description: The details about the associated legacy enrollment. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
startDate:
{
Description: Enrollment Start Date ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Enrollment End Date ,
Format: date-time ,
Required: False ,
}
string ,
currency:
{
Description: The currency associated with enrollment ,
Required: False ,
}
string ,
channel:
{
Description: The channel for Enrollment ,
Required: False ,
}
string ,
policies:
{
Description: The attributes associated with legacy enrollment. ,
Required: False ,
}
{
accountOwnerViewCharges:
{
Description: The accountOwnerViewCharges flag for Enrollment ,
Required: False ,
}
boolean ,
departmentAdminViewCharges:
{
Description: The departmentAdminViewCharges flag for Enrollment ,
Required: False ,
}
boolean ,
marketplacesEnabled:
{
Description: The marketplaces flag for Enrollment ,
Required: False ,
}
boolean ,
reservedInstancesEnabled:
{
Description: The reserved instances flag for Enrollment ,
Required: False ,
}
boolean ,
}
,
language:
{
Description: The language for Enrollment ,
Required: False ,
}
string ,
countryCode:
{
Description: The countryCode for Enrollment ,
Required: False ,
}
string ,
status:
{
Description: Enrollment status ,
Required: False ,
}
string ,
billingCycle:
{
Description: Enrollment billing cycle ,
Required: False ,
}
string ,
}
,
departments:
{
Description: The departments associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: A department. ,
Required: False ,
}
{
departmentName:
{
Description: The name for department. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
status:
{
Description: The status for 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: An account. ,
Required: False ,
}
{
accountName:
{
Description: The account name. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The account owner ,
Required: False ,
}
string ,
status:
{
Description: The status for account. ,
Required: False ,
}
string ,
startDate:
{
Description: Account Start Date ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Account End Date ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
enrollmentAccounts:
{
Description: The accounts associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: An account. ,
Required: False ,
}
{
accountName:
{
Description: The account name. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The account owner ,
Required: False ,
}
string ,
status:
{
Description: The status for account. ,
Required: False ,
}
string ,
startDate:
{
Description: Account Start Date ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Account End Date ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
hasReadAccess:
{
Description: Specifies whether the user has read access on billing account. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A billing account. ,
Required: False ,
}
{
displayName:
{
Description: The billing account name. ,
Required: False ,
}
string ,
accountType:
{
Description: The billing account Type. ,
Enum:
{
Organization: No description available. ,
Enrollment: No description available. ,
}
,
Required: False ,
}
enum ,
address:
{
Description: The address associated with billing account. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
company:
{
Description: Company Name. ,
Required: False ,
}
string ,
country:
{
Description: Country Name. ,
Required: False ,
}
string ,
invoiceSections:
{
Description: The invoice sections associated to the billing account. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: The InvoiceSection. ,
Required: False ,
}
{
displayName:
{
Description: The name of the InvoiceSection. ,
Required: False ,
}
string ,
billingProfiles:
{
Description: The billing profiles associated to the billing account. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
billingProfiles:
{
Description: The billing profiles associated to the billing account. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
enrollmentDetails:
{
Description: The details about the associated legacy enrollment. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
startDate:
{
Description: Enrollment Start Date ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Enrollment End Date ,
Format: date-time ,
Required: False ,
}
string ,
currency:
{
Description: The currency associated with enrollment ,
Required: False ,
}
string ,
channel:
{
Description: The channel for Enrollment ,
Required: False ,
}
string ,
policies:
{
Description: The attributes associated with legacy enrollment. ,
Required: False ,
}
{
accountOwnerViewCharges:
{
Description: The accountOwnerViewCharges flag for Enrollment ,
Required: False ,
}
boolean ,
departmentAdminViewCharges:
{
Description: The departmentAdminViewCharges flag for Enrollment ,
Required: False ,
}
boolean ,
marketplacesEnabled:
{
Description: The marketplaces flag for Enrollment ,
Required: False ,
}
boolean ,
reservedInstancesEnabled:
{
Description: The reserved instances flag for Enrollment ,
Required: False ,
}
boolean ,
}
,
language:
{
Description: The language for Enrollment ,
Required: False ,
}
string ,
countryCode:
{
Description: The countryCode for Enrollment ,
Required: False ,
}
string ,
status:
{
Description: Enrollment status ,
Required: False ,
}
string ,
billingCycle:
{
Description: Enrollment billing cycle ,
Required: False ,
}
string ,
}
,
departments:
{
Description: The departments associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: A department. ,
Required: False ,
}
{
departmentName:
{
Description: The name for department. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
status:
{
Description: The status for 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: An account. ,
Required: False ,
}
{
accountName:
{
Description: The account name. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The account owner ,
Required: False ,
}
string ,
status:
{
Description: The status for account. ,
Required: False ,
}
string ,
startDate:
{
Description: Account Start Date ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Account End Date ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
enrollmentAccounts:
{
Description: The accounts associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: An account. ,
Required: False ,
}
{
accountName:
{
Description: The account name. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The account owner ,
Required: False ,
}
string ,
status:
{
Description: The status for account. ,
Required: False ,
}
string ,
startDate:
{
Description: Account Start Date ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Account End Date ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
hasReadAccess:
{
Description: Specifies whether the user has read access on billing account. ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
PaymentMethods_ListByBillingAccountName (new)
Description :  Lists the Payment Methods by billing account Id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/paymentMethods
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Addresses_Validate (new)
Description :  Validates the address.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/validateAddress
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
address:
{
Required: True ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
AvailableBalances_GetByBillingProfile (new)
Description :  The latest available credit balance for a given billingAccountName and billingProfileName.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/availableBalance/default
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
PaymentMethods_ListByBillingProfileName (new)
Description :  Lists the Payment Methods by billing profile Id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/paymentMethods
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
BillingProfiles_ListByBillingAccountName (new)
Description :  Lists all billing profiles for a user which that user has access to.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the invoiceSections. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing profiles. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
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 ,
}
,
}
BillingProfiles_Create (new)
Description :  The operation to create a BillingProfile.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create BillingProfile operation. ,
Required: True ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
enableAzureSKUs:
{
Description: Azure skus to enable for this billing profile.. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result ,
}
string ,
retry-after:
{
Description: Recommends the retryable time after receiving this. ,
}
integer ,
azure-asyncoperation:
{
Description: URI to poll for the operation status ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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 :  Get the billing profile by id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the invoiceSections. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
BillingProfiles_Update (new)
Description :  The operation to update a billing profile.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the update billing profile operation. ,
Required: True ,
}
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Customers_ListByBillingAccountName (new)
Description :  Lists all customers which the current user can work with on-behalf of a partner.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter using hasPermission('{permissionId}') to only return customers for which the caller has the specified permission. ,
Required: False ,
}
string ,
$skiptoken:
{
Description: Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of customers. ,
Required: False ,
}
[
{
properties:
{
Description: The customer. ,
Required: False ,
}
{
displayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
resellers:
{
Description: The resellers which are allowed to provide service to this customer. ,
Required: False ,
}
[
{
resellerId:
{
Description: The reseller id. ,
Required: False ,
}
string ,
description:
{
Description: A description of the reseller. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Customers_Get (new)
Description :  Get the customer by id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
customerName:
{
Description: Customer Id. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand enabledAzureSkus, resellers. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The customer. ,
Required: False ,
}
{
displayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
resellers:
{
Description: The resellers which are allowed to provide service to this customer. ,
Required: False ,
}
[
{
resellerId:
{
Description: The reseller id. ,
Required: False ,
}
string ,
description:
{
Description: A description 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 ,
}
,
}
InvoiceSections_ListByBillingAccountName (new)
Description :  Lists all invoice sections for which a user has access.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the billingProfiles. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of invoice sections. ,
Required: False ,
}
[
{
properties:
{
Description: The InvoiceSection. ,
Required: False ,
}
{
displayName:
{
Description: The name of the InvoiceSection. ,
Required: False ,
}
string ,
billingProfiles:
{
Description: The billing profiles associated to the billing account. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
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 ,
}
,
}
InvoiceSections_Create (new)
Description :  The operation to create a InvoiceSection.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create InvoiceSection operation. ,
Required: True ,
}
{
displayName:
{
Description: The name of the InvoiceSection. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The billing profile id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The InvoiceSection. ,
Required: False ,
}
{
displayName:
{
Description: The name of the InvoiceSection. ,
Required: False ,
}
string ,
billingProfiles:
{
Description: The billing profiles associated to the billing account. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result ,
}
string ,
retry-after:
{
Description: Recommends the retryable time after receiving this. ,
}
integer ,
azure-asyncoperation:
{
Description: URI to poll for the operation status ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_ListByBillingProfileName (new)
Description :  Lists all invoice sections under a billing profile for which a user has access.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of invoice sections. ,
Required: False ,
}
[
{
properties:
{
Description: The InvoiceSection. ,
Required: False ,
}
{
displayName:
{
Description: The name of the InvoiceSection. ,
Required: False ,
}
string ,
billingProfiles:
{
Description: The billing profiles associated to the billing account. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
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 ,
}
,
}
InvoiceSections_ListByCreateSubscriptionPermission (new)
Description :  Lists all invoiceSections with create subscription permission for a user.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/listInvoiceSectionsWithCreateSubscriptionPermission
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the billingProfiles. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of invoice sections. ,
Required: False ,
}
[
{
properties:
{
Description: The InvoiceSection. ,
Required: False ,
}
{
displayName:
{
Description: The name of the InvoiceSection. ,
Required: False ,
}
string ,
billingProfiles:
{
Description: The billing profiles associated to the billing account. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
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 ,
}
,
}
InvoiceSections_Get (new)
Description :  Get the InvoiceSection by id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the billingProfiles. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The InvoiceSection. ,
Required: False ,
}
{
displayName:
{
Description: The name of the InvoiceSection. ,
Required: False ,
}
string ,
billingProfiles:
{
Description: The billing profiles associated to the billing account. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
InvoiceSections_Update (new)
Description :  The operation to update a InvoiceSection.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create InvoiceSection operation. ,
Required: True ,
}
{
properties:
{
Description: The InvoiceSection. ,
Required: False ,
}
{
displayName:
{
Description: The name of the InvoiceSection. ,
Required: False ,
}
string ,
billingProfiles:
{
Description: The billing profiles associated to the billing account. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The InvoiceSection. ,
Required: False ,
}
{
displayName:
{
Description: The name of the InvoiceSection. ,
Required: False ,
}
string ,
billingProfiles:
{
Description: The billing profiles associated to the billing account. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Departments_ListByBillingAccountName (new)
Description :  Lists all departments for which a user has access.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the enrollmentAccounts. ,
Required: False ,
}
string ,
$filter:
{
Description: 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 is separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of departments. ,
Required: False ,
}
[
{
properties:
{
Description: A department. ,
Required: False ,
}
{
departmentName:
{
Description: The name for department. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
status:
{
Description: The status for 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: An account. ,
Required: False ,
}
{
accountName:
{
Description: The account name. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The account owner ,
Required: False ,
}
string ,
status:
{
Description: The status for account. ,
Required: False ,
}
string ,
startDate:
{
Description: Account Start Date ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Account End Date ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Departments_Get (new)
Description :  Get the department by id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
departmentName:
{
Description: Department Id. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the enrollmentAccounts. ,
Required: False ,
}
string ,
$filter:
{
Description: 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 is separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A department. ,
Required: False ,
}
{
departmentName:
{
Description: The name for department. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
status:
{
Description: The status for 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: An account. ,
Required: False ,
}
{
accountName:
{
Description: The account name. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The account owner ,
Required: False ,
}
string ,
status:
{
Description: The status for account. ,
Required: False ,
}
string ,
startDate:
{
Description: Account Start Date ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Account End Date ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
EnrollmentAccounts_ListByBillingAccountName (new)
Description :  Lists all Enrollment Accounts for which a user has access.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the department. ,
Required: False ,
}
string ,
$filter:
{
Description: 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 is separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
EnrollmentAccounts_GetByEnrollmentAccountId (new)
Description :  Get the enrollment account by id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
enrollmentAccountName:
{
Description: Enrollment Account Id. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the Department. ,
Required: False ,
}
string ,
$filter:
{
Description: 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 is separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: An account. ,
Required: False ,
}
{
accountName:
{
Description: The account name. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The account owner ,
Required: False ,
}
string ,
status:
{
Description: The status for account. ,
Required: False ,
}
string ,
startDate:
{
Description: Account Start Date ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Account End Date ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Invoices_ListByBillingAccountName (new)
Description :  List of invoices for a billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: Invoice period start date. ,
Required: True ,
}
string ,
periodEndDate:
{
Description: Invoice period end date. ,
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 invoice. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceDate:
{
Description: The date when invoice was created. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Invoice status. ,
Enum:
{
PastDue: No description available. ,
Due: No description available. ,
Paid: No description available. ,
Void: No description available. ,
}
,
Required: False ,
}
enum ,
amountDue:
{
Description: Amount due. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billedAmount:
{
Description: Amount billed. ,
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. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end date of the billing period. ,
Format: date-time ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The billing profile id this invoice belongs to. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The profile name this invoice belongs to. ,
Required: False ,
}
string ,
purchaseOrderNumber:
{
Description: The purchase identifier for the invoice. ,
Required: False ,
}
string ,
documentUrls:
{
Description: List of document urls available to download including invoice and tax documents. ,
Required: False ,
}
[
{
kind:
{
Description: Document type. ,
Enum:
{
Invoice: No description available. ,
VoidNote: No description available. ,
Receipt: No description available. ,
CreditNote: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: Document URL. ,
Required: False ,
}
string ,
}
,
]
,
payments:
{
Description: List of payments. ,
Required: False ,
}
[
{
paymentType:
{
Description: The type of payment. ,
Required: False ,
}
string ,
amount:
{
Description: The paid amount. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
date:
{
Description: The date of the payment. ,
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 ,
}
,
}
PriceSheet_Download (new)
Description :  Download price sheet for an invoice.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/pricesheet/default/download
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Azure Billing Account ID. ,
Required: True ,
}
string ,
invoiceName:
{
Description: The name of an invoice resource. ,
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 ,
azure-asyncoperation:
{
Description: To get the progress of the operation, call GET operation on the URL in Azure-AsyncOperation header field. ,
}
string ,
odata-entityid:
{
Description: The operation entity Id GUID. ,
}
string ,
}

⚐ Response (200)

{
expiryTime:
{
Description: The time in UTC at which this 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 ,
}
,
}
Invoices_ListByBillingProfile (new)
Description :  List of invoices for a billing profile.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: Invoice period start date. ,
Required: True ,
}
string ,
periodEndDate:
{
Description: Invoice period end date. ,
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 invoice. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceDate:
{
Description: The date when invoice was created. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Invoice status. ,
Enum:
{
PastDue: No description available. ,
Due: No description available. ,
Paid: No description available. ,
Void: No description available. ,
}
,
Required: False ,
}
enum ,
amountDue:
{
Description: Amount due. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billedAmount:
{
Description: Amount billed. ,
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. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end date of the billing period. ,
Format: date-time ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The billing profile id this invoice belongs to. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The profile name this invoice belongs to. ,
Required: False ,
}
string ,
purchaseOrderNumber:
{
Description: The purchase identifier for the invoice. ,
Required: False ,
}
string ,
documentUrls:
{
Description: List of document urls available to download including invoice and tax documents. ,
Required: False ,
}
[
{
kind:
{
Description: Document type. ,
Enum:
{
Invoice: No description available. ,
VoidNote: No description available. ,
Receipt: No description available. ,
CreditNote: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: Document URL. ,
Required: False ,
}
string ,
}
,
]
,
payments:
{
Description: List of payments. ,
Required: False ,
}
[
{
paymentType:
{
Description: The type of payment. ,
Required: False ,
}
string ,
amount:
{
Description: The paid amount. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
date:
{
Description: The date of the payment. ,
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 ,
}
,
}
Invoices_Get (new)
Description :  Get the invoice by name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices/{invoiceName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
invoiceName:
{
Description: Invoice Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: An invoice. ,
Required: False ,
}
{
dueDate:
{
Description: The due date for invoice. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceDate:
{
Description: The date when invoice was created. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Invoice status. ,
Enum:
{
PastDue: No description available. ,
Due: No description available. ,
Paid: No description available. ,
Void: No description available. ,
}
,
Required: False ,
}
enum ,
amountDue:
{
Description: Amount due. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billedAmount:
{
Description: Amount billed. ,
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. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end date of the billing period. ,
Format: date-time ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The billing profile id this invoice belongs to. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The profile name this invoice belongs to. ,
Required: False ,
}
string ,
purchaseOrderNumber:
{
Description: The purchase identifier for the invoice. ,
Required: False ,
}
string ,
documentUrls:
{
Description: List of document urls available to download including invoice and tax documents. ,
Required: False ,
}
[
{
kind:
{
Description: Document type. ,
Enum:
{
Invoice: No description available. ,
VoidNote: No description available. ,
Receipt: No description available. ,
CreditNote: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: Document URL. ,
Required: False ,
}
string ,
}
,
]
,
payments:
{
Description: List of payments. ,
Required: False ,
}
[
{
paymentType:
{
Description: The type of payment. ,
Required: False ,
}
string ,
amount:
{
Description: The paid amount. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
date:
{
Description: The date of the payment. ,
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 ,
}
,
}
BillingSubscriptions_ListByBillingAccountName (new)
Description :  Lists billing subscriptions by billing account name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing subscriptions summary. ,
Required: False ,
}
[
{
properties:
{
Description: The usage context properties. ,
Required: False ,
}
{
displayName:
{
Description: display name. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
subscriptionBillingStatus:
{
Description: Subscription billing status. ,
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: 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: 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: Billing Profile id to which this product belongs. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing Profile name to which this product belongs. ,
Required: False ,
}
string ,
customerId:
{
Description: Customer id to which this product belongs. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: Display name of customer to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice section id to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice section name to which this product belongs. ,
Required: False ,
}
string ,
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this subscription. ,
Required: False ,
}
{
resellerId:
{
Description: The reseller id. ,
Required: False ,
}
string ,
description:
{
Description: A description of the reseller. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
BillingSubscriptions_ListByBillingProfileName (new)
Description :  Lists billing subscriptions by billing profile name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingSubscriptions
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing subscriptions summary. ,
Required: False ,
}
[
{
properties:
{
Description: The usage context properties. ,
Required: False ,
}
{
displayName:
{
Description: display name. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
subscriptionBillingStatus:
{
Description: Subscription billing status. ,
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: 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: 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: Billing Profile id to which this product belongs. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing Profile name to which this product belongs. ,
Required: False ,
}
string ,
customerId:
{
Description: Customer id to which this product belongs. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: Display name of customer to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice section id to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice section name to which this product belongs. ,
Required: False ,
}
string ,
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this subscription. ,
Required: False ,
}
{
resellerId:
{
Description: The reseller id. ,
Required: False ,
}
string ,
description:
{
Description: A description of the reseller. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
BillingSubscriptions_ListByCustomerName (new)
Description :  Lists billing subscription by customer name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/billingSubscriptions
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
customerName:
{
Description: Customer Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing subscriptions summary. ,
Required: False ,
}
[
{
properties:
{
Description: The usage context properties. ,
Required: False ,
}
{
displayName:
{
Description: display name. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
subscriptionBillingStatus:
{
Description: Subscription billing status. ,
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: 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: 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: Billing Profile id to which this product belongs. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing Profile name to which this product belongs. ,
Required: False ,
}
string ,
customerId:
{
Description: Customer id to which this product belongs. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: Display name of customer to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice section id to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice section name to which this product belongs. ,
Required: False ,
}
string ,
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this subscription. ,
Required: False ,
}
{
resellerId:
{
Description: The reseller id. ,
Required: False ,
}
string ,
description:
{
Description: A description of the reseller. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
BillingSubscriptions_GetByCustomerName (new)
Description :  Get a single billing subscription by name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/billingSubscriptions/{billingSubscriptionName}
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
customerName:
{
Description: Customer Id. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: Billing Subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The usage context properties. ,
Required: False ,
}
{
displayName:
{
Description: display name. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
subscriptionBillingStatus:
{
Description: Subscription billing status. ,
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: 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: 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: Billing Profile id to which this product belongs. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing Profile name to which this product belongs. ,
Required: False ,
}
string ,
customerId:
{
Description: Customer id to which this product belongs. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: Display name of customer to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice section id to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice section name to which this product belongs. ,
Required: False ,
}
string ,
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this subscription. ,
Required: False ,
}
{
resellerId:
{
Description: The reseller id. ,
Required: False ,
}
string ,
description:
{
Description: A description 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 ,
}
,
}
BillingSubscriptions_ListByInvoiceSectionName (new)
Description :  Lists billing subscription by invoice section name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/billingSubscriptions
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing subscriptions summary. ,
Required: False ,
}
[
{
properties:
{
Description: The usage context properties. ,
Required: False ,
}
{
displayName:
{
Description: display name. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
subscriptionBillingStatus:
{
Description: Subscription billing status. ,
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: 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: 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: Billing Profile id to which this product belongs. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing Profile name to which this product belongs. ,
Required: False ,
}
string ,
customerId:
{
Description: Customer id to which this product belongs. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: Display name of customer to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice section id to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice section name to which this product belongs. ,
Required: False ,
}
string ,
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this subscription. ,
Required: False ,
}
{
resellerId:
{
Description: The reseller id. ,
Required: False ,
}
string ,
description:
{
Description: A description of the reseller. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
BillingSubscriptions_Get (new)
Description :  Get a single billing subscription by name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/billingSubscriptions/{billingSubscriptionName}
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: Billing Subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The usage context properties. ,
Required: False ,
}
{
displayName:
{
Description: display name. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
subscriptionBillingStatus:
{
Description: Subscription billing status. ,
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: 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: 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: Billing Profile id to which this product belongs. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing Profile name to which this product belongs. ,
Required: False ,
}
string ,
customerId:
{
Description: Customer id to which this product belongs. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: Display name of customer to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice section id to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice section name to which this product belongs. ,
Required: False ,
}
string ,
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this subscription. ,
Required: False ,
}
{
resellerId:
{
Description: The reseller id. ,
Required: False ,
}
string ,
description:
{
Description: A description 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 ,
}
,
}
BillingSubscriptions_Transfer (new)
Description :  Transfers the subscription from one invoice section to another within a billing account.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/billingSubscriptions/{billingSubscriptionName}/transfer
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: Billing Subscription Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Transfer Billing Subscription operation. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: False ,
}
string ,
destinationBillingProfileId:
{
Description: The destination billing profile id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Request parameters to transfer billing subscription. ,
Required: False ,
}
{
billingSubscriptionName:
{
Description: The destination billing subscription id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result. ,
}
string ,
retry-after:
{
Description: Recommends the retryable time after receiving this. ,
}
integer ,
azure-asyncoperation:
{
Description: URI to poll for the operation status ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
BillingSubscriptions_ValidateTransfer (new)
Description :  Validates the transfer of billing subscriptions across invoice sections.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/billingSubscriptions/{billingSubscriptionName}/validateTransferEligibility
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: Billing Subscription Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Transfer Billing Subscription operation. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: False ,
}
string ,
destinationBillingProfileId:
{
Description: The destination billing profile id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
isTransferEligible:
{
Description: Specifies whether the transfer is eligible or not. ,
Required: False ,
}
boolean ,
errorDetails:
{
Description: Validation error details. ,
Required: False ,
}
{
code:
{
Description: Error code for the product transfer validation. ,
Enum:
{
InvalidSource: No description available. ,
SubscriptionNotActive: No description available. ,
InsufficientPermissionOnSource: No description available. ,
InsufficientPermissionOnDestination: No description available. ,
DestinationBillingProfilePastDue: No description available. ,
SubscriptionTypeNotSupported: No description available. ,
CrossBillingAccountNotAllowed: No description available. ,
NotAvailableForDestinationMarket: 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 ,
}
,
}
Products_ListByBillingAccountName (new)
Description :  Lists products by billing account name.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of products summary. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the product summary. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date of purchase. ,
Format: date-time ,
Required: False ,
}
string ,
productTypeId:
{
Description: The product type id. ,
Required: False ,
}
string ,
productType:
{
Description: The type of product. ,
Required: False ,
}
string ,
status:
{
Description: Product status. ,
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: end date. ,
Format: date-time ,
Required: False ,
}
string ,
billingFrequency:
{
Description: Billing frequency. ,
Enum:
{
OneTime: No description available. ,
Monthly: No description available. ,
UsageBased: No description available. ,
}
,
Required: False ,
}
enum ,
lastCharge:
{
Description: 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 purchased product quantity. ,
Required: False ,
}
number ,
skuId:
{
Description: Sku Id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: Sku description. ,
Required: False ,
}
string ,
availabilityId:
{
Description: Availability Id. ,
Required: False ,
}
string ,
parentProductId:
{
Description: Parent Product Id. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice section id to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice section name to which this product belongs. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing Profile id to which this product belongs. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing Profile name to which this product belongs. ,
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 ,
}
,
}
Products_ListByInvoiceSectionName (new)
Description :  Lists products by invoice section name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/products
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter by product type. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of products summary. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the product summary. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date of purchase. ,
Format: date-time ,
Required: False ,
}
string ,
productTypeId:
{
Description: The product type id. ,
Required: False ,
}
string ,
productType:
{
Description: The type of product. ,
Required: False ,
}
string ,
status:
{
Description: Product status. ,
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: end date. ,
Format: date-time ,
Required: False ,
}
string ,
billingFrequency:
{
Description: Billing frequency. ,
Enum:
{
OneTime: No description available. ,
Monthly: No description available. ,
UsageBased: No description available. ,
}
,
Required: False ,
}
enum ,
lastCharge:
{
Description: 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 purchased product quantity. ,
Required: False ,
}
number ,
skuId:
{
Description: Sku Id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: Sku description. ,
Required: False ,
}
string ,
availabilityId:
{
Description: Availability Id. ,
Required: False ,
}
string ,
parentProductId:
{
Description: Parent Product Id. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice section id to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice section name to which this product belongs. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing Profile id to which this product belongs. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing Profile name to which this product belongs. ,
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 ,
}
,
}
Products_Get (new)
Description :  Get a single product by name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/products/{productName}
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
productName:
{
Description: Invoice Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the product summary. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date of purchase. ,
Format: date-time ,
Required: False ,
}
string ,
productTypeId:
{
Description: The product type id. ,
Required: False ,
}
string ,
productType:
{
Description: The type of product. ,
Required: False ,
}
string ,
status:
{
Description: Product status. ,
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: end date. ,
Format: date-time ,
Required: False ,
}
string ,
billingFrequency:
{
Description: Billing frequency. ,
Enum:
{
OneTime: No description available. ,
Monthly: No description available. ,
UsageBased: No description available. ,
}
,
Required: False ,
}
enum ,
lastCharge:
{
Description: 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 purchased product quantity. ,
Required: False ,
}
number ,
skuId:
{
Description: Sku Id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: Sku description. ,
Required: False ,
}
string ,
availabilityId:
{
Description: Availability Id. ,
Required: False ,
}
string ,
parentProductId:
{
Description: Parent Product Id. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice section id to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice section name to which this product belongs. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing Profile id to which this product belongs. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing Profile name to which this product belongs. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Products_Transfer (new)
Description :  The operation to transfer a Product to another invoice section.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/products/{productName}/transfer
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
productName:
{
Description: Invoice Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Transfer Product operation. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: False ,
}
string ,
destinationBillingProfileId:
{
Description: The destination billing profile id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the product summary. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date of purchase. ,
Format: date-time ,
Required: False ,
}
string ,
productTypeId:
{
Description: The product type id. ,
Required: False ,
}
string ,
productType:
{
Description: The type of product. ,
Required: False ,
}
string ,
status:
{
Description: Product status. ,
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: end date. ,
Format: date-time ,
Required: False ,
}
string ,
billingFrequency:
{
Description: Billing frequency. ,
Enum:
{
OneTime: No description available. ,
Monthly: No description available. ,
UsageBased: No description available. ,
}
,
Required: False ,
}
enum ,
lastCharge:
{
Description: 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 purchased product quantity. ,
Required: False ,
}
number ,
skuId:
{
Description: Sku Id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: Sku description. ,
Required: False ,
}
string ,
availabilityId:
{
Description: Availability Id. ,
Required: False ,
}
string ,
parentProductId:
{
Description: Parent Product Id. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice section id to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice section name to which this product belongs. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing Profile id to which this product belongs. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing Profile name to which this product belongs. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result ,
}
string ,
retry-after:
{
Description: Recommends the retryable time after receiving this. ,
}
integer ,
azure-asyncoperation:
{
Description: URI to poll for the operation status ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Products_ValidateTransfer (new)
Description :  Validates the transfer of products across invoice sections.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/products/{productName}/validateTransferEligibility
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
productName:
{
Description: Invoice Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Transfer Products operation. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: False ,
}
string ,
destinationBillingProfileId:
{
Description: The destination billing profile id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Transactions_ListByBillingAccountName (new)
Description :  Lists the transactions by billing account name for given start and end date.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/transactions
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
startDate:
{
Description: Start date ,
Required: True ,
}
string ,
endDate:
{
Description: End date ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter by transaction kind. 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 is separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservation transactions summary. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the reservation transaction summary. ,
Required: False ,
}
{
kind:
{
Description: The kind of transaction. Choices are all and reservation. ,
Enum:
{
all: No description available. ,
reservation: No description available. ,
}
,
Required: False ,
}
enum ,
date:
{
Description: The date of reservation transaction. ,
Format: date-time ,
Required: False ,
}
string ,
invoice:
{
Description: Invoice number or 'pending' if not invoiced. ,
Required: False ,
}
string ,
orderId:
{
Description: The reservation order id. ,
Required: False ,
}
string ,
orderName:
{
Description: The reservation order name. ,
Required: False ,
}
string ,
productFamily:
{
Description: The product family. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The product type id. ,
Required: False ,
}
string ,
productType:
{
Description: The type of product. ,
Required: False ,
}
string ,
productDescription:
{
Description: Product description. ,
Required: False ,
}
string ,
transactionType:
{
Description: Transaction types. ,
Enum:
{
Purchase: No description available. ,
Usage Charge: No description available. ,
}
,
Required: False ,
}
enum ,
transactionAmount:
{
Description: Last charge associated with the purchase. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
quantity:
{
Description: Purchase quantity. ,
Format: int32 ,
Required: False ,
}
integer ,
customerId:
{
Description: Customer id to which this product belongs. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: Display name of customer to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice section id to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice section name to which this product belongs. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing Profile id to which this product belongs. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing Profile name to which this product belongs. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription id. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The subscription name. ,
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 ,
}
,
}
Transactions_ListByBillingProfileName (new)
Description :  Lists the transactions by billing profile name for given start date and end date.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/transactions
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
startDate:
{
Description: Start date ,
Required: True ,
}
string ,
endDate:
{
Description: End date ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter by transaction kind. 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 is separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservation transactions summary. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the reservation transaction summary. ,
Required: False ,
}
{
kind:
{
Description: The kind of transaction. Choices are all and reservation. ,
Enum:
{
all: No description available. ,
reservation: No description available. ,
}
,
Required: False ,
}
enum ,
date:
{
Description: The date of reservation transaction. ,
Format: date-time ,
Required: False ,
}
string ,
invoice:
{
Description: Invoice number or 'pending' if not invoiced. ,
Required: False ,
}
string ,
orderId:
{
Description: The reservation order id. ,
Required: False ,
}
string ,
orderName:
{
Description: The reservation order name. ,
Required: False ,
}
string ,
productFamily:
{
Description: The product family. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The product type id. ,
Required: False ,
}
string ,
productType:
{
Description: The type of product. ,
Required: False ,
}
string ,
productDescription:
{
Description: Product description. ,
Required: False ,
}
string ,
transactionType:
{
Description: Transaction types. ,
Enum:
{
Purchase: No description available. ,
Usage Charge: No description available. ,
}
,
Required: False ,
}
enum ,
transactionAmount:
{
Description: Last charge associated with the purchase. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
quantity:
{
Description: Purchase quantity. ,
Format: int32 ,
Required: False ,
}
integer ,
customerId:
{
Description: Customer id to which this product belongs. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: Display name of customer to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice section id to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice section name to which this product belongs. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing Profile id to which this product belongs. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing Profile name to which this product belongs. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription id. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The subscription name. ,
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 ,
}
,
}
Transactions_ListByCustomerName (new)
Description :  Lists the transactions by invoice section name for given start date and end date.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/transactions
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
customerName:
{
Description: Customer Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
startDate:
{
Description: Start date ,
Required: True ,
}
string ,
endDate:
{
Description: End date ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter by transaction kind. 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 is separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservation transactions summary. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the reservation transaction summary. ,
Required: False ,
}
{
kind:
{
Description: The kind of transaction. Choices are all and reservation. ,
Enum:
{
all: No description available. ,
reservation: No description available. ,
}
,
Required: False ,
}
enum ,
date:
{
Description: The date of reservation transaction. ,
Format: date-time ,
Required: False ,
}
string ,
invoice:
{
Description: Invoice number or 'pending' if not invoiced. ,
Required: False ,
}
string ,
orderId:
{
Description: The reservation order id. ,
Required: False ,
}
string ,
orderName:
{
Description: The reservation order name. ,
Required: False ,
}
string ,
productFamily:
{
Description: The product family. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The product type id. ,
Required: False ,
}
string ,
productType:
{
Description: The type of product. ,
Required: False ,
}
string ,
productDescription:
{
Description: Product description. ,
Required: False ,
}
string ,
transactionType:
{
Description: Transaction types. ,
Enum:
{
Purchase: No description available. ,
Usage Charge: No description available. ,
}
,
Required: False ,
}
enum ,
transactionAmount:
{
Description: Last charge associated with the purchase. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
quantity:
{
Description: Purchase quantity. ,
Format: int32 ,
Required: False ,
}
integer ,
customerId:
{
Description: Customer id to which this product belongs. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: Display name of customer to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice section id to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice section name to which this product belongs. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing Profile id to which this product belongs. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing Profile name to which this product belongs. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription id. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The subscription name. ,
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 ,
}
,
}
Transactions_ListByInvoiceSectionName (new)
Description :  Lists the transactions by invoice section name for given start date and end date.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/transactions
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
startDate:
{
Description: Start date ,
Required: True ,
}
string ,
endDate:
{
Description: End date ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter by transaction kind. 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 is separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservation transactions summary. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the reservation transaction summary. ,
Required: False ,
}
{
kind:
{
Description: The kind of transaction. Choices are all and reservation. ,
Enum:
{
all: No description available. ,
reservation: No description available. ,
}
,
Required: False ,
}
enum ,
date:
{
Description: The date of reservation transaction. ,
Format: date-time ,
Required: False ,
}
string ,
invoice:
{
Description: Invoice number or 'pending' if not invoiced. ,
Required: False ,
}
string ,
orderId:
{
Description: The reservation order id. ,
Required: False ,
}
string ,
orderName:
{
Description: The reservation order name. ,
Required: False ,
}
string ,
productFamily:
{
Description: The product family. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The product type id. ,
Required: False ,
}
string ,
productType:
{
Description: The type of product. ,
Required: False ,
}
string ,
productDescription:
{
Description: Product description. ,
Required: False ,
}
string ,
transactionType:
{
Description: Transaction types. ,
Enum:
{
Purchase: No description available. ,
Usage Charge: No description available. ,
}
,
Required: False ,
}
enum ,
transactionAmount:
{
Description: Last charge associated with the purchase. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
quantity:
{
Description: Purchase quantity. ,
Format: int32 ,
Required: False ,
}
integer ,
customerId:
{
Description: Customer id to which this product belongs. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: Display name of customer to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice section id to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice section name to which this product belongs. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing Profile id to which this product belongs. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing Profile name to which this product belongs. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription id. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The subscription name. ,
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 ,
}
,
}
Policies_GetByBillingProfileName (new)
Description :  The policy for a given billing account name and billing profile name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/policies/default
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of policy. ,
Required: False ,
}
{
marketplacePurchasesAllowed:
{
Description: The marketplacePurchasesAllowed flag. ,
Required: False ,
}
boolean ,
reservationPurchasesAllowed:
{
Description: The reservationPurchasesAllowed flag. ,
Required: False ,
}
boolean ,
subscriptionOwnerCanViewCharges:
{
Description: The subscriptionOwnerCanViewCharges flag. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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 :  The operation to update a policy.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/policies/default
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the update policy operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of policy. ,
Required: False ,
}
{
marketplacePurchasesAllowed:
{
Description: The marketplacePurchasesAllowed flag. ,
Required: False ,
}
boolean ,
reservationPurchasesAllowed:
{
Description: The reservationPurchasesAllowed flag. ,
Required: False ,
}
boolean ,
subscriptionOwnerCanViewCharges:
{
Description: The subscriptionOwnerCanViewCharges flag. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of policy. ,
Required: False ,
}
{
marketplacePurchasesAllowed:
{
Description: The marketplacePurchasesAllowed flag. ,
Required: False ,
}
boolean ,
reservationPurchasesAllowed:
{
Description: The reservationPurchasesAllowed flag. ,
Required: False ,
}
boolean ,
subscriptionOwnerCanViewCharges:
{
Description: The subscriptionOwnerCanViewCharges flag. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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 billing property by subscription Id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingProperty
{
subscriptionId:
{
Description: Azure Subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A billing property. ,
Required: False ,
}
{
billingTenantId:
{
Description: Billing tenant Id. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: Billing account Id. ,
Required: False ,
}
string ,
billingAccountName:
{
Description: Billing account name. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing profile Id. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing profile name. ,
Required: False ,
}
string ,
costCenter:
{
Description: Cost center name. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice Section Id. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice Section name. ,
Required: False ,
}
string ,
productId:
{
Description: Product Id. ,
Required: False ,
}
string ,
productName:
{
Description: Product name. ,
Required: False ,
}
string ,
skuId:
{
Description: SKU Id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: SKU description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_UpdateAutoRenewByBillingAccountName (new)
Description :  Cancel auto renew for product by product id and billing account name
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products/{productName}/updateAutoRenew
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
productName:
{
Description: Invoice Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
body:
{
Description: Update auto renew request parameters. ,
Required: True ,
}
{
autoRenew:
{
Description: Request parameters to update auto renew policy a product. ,
Enum:
{
true: No description available. ,
false: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Summary of update auto renew operation summary properties ,
Required: False ,
}
{
endDate:
{
Description: The end date of this asset ,
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 ,
}
,
}
Products_UpdateAutoRenewByInvoiceSectionName (new)
Description :  Cancel auto renew for product by product id and invoice section name
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/products/{productName}/updateAutoRenew
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
productName:
{
Description: Invoice Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
body:
{
Description: Update auto renew request parameters. ,
Required: True ,
}
{
autoRenew:
{
Description: Request parameters to update auto renew policy a product. ,
Enum:
{
true: No description available. ,
false: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Summary of update auto renew operation summary properties ,
Required: False ,
}
{
endDate:
{
Description: The end date of this asset ,
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 ,
}
,
}
InvoiceSections_ElevateToBillingProfile (new)
Description :  Elevates the caller's access to match their billing profile access.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/elevate
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Transfers_Initiate (new)
Description :  Initiates the request to transfer the legacy subscriptions or RIs.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/initiateTransfer
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
body:
{
Description: Initiate transfer parameters. ,
Required: True ,
}
{
properties:
{
Description: Request parameters to initiate transfer. ,
Required: False ,
}
{
billingProfileId:
{
Description: Target Usage context for devTest subscriptions. ,
Required: False ,
}
string ,
recipientEmailId:
{
Description: Email Id of recipient for transfer. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: Transfer creation time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Transfer expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Target invoice section Id. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: Target billing account Id. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: Email Id of recipient of transfer. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: Email Id of initiator of transfer. ,
Required: False ,
}
string ,
canceledBy:
{
Description: Email Id who user canceled the transfer. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Transfer last modification time. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product being transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: Id of product being transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Transfers_Get (new)
Description :  Gets the transfer details for given transfer Id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/transfers/{transferName}
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
transferName:
{
Description: Transfer Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: Transfer creation time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Transfer expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Target invoice section Id. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: Target billing account Id. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: Email Id of recipient of transfer. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: Email Id of initiator of transfer. ,
Required: False ,
}
string ,
canceledBy:
{
Description: Email Id who user canceled the transfer. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Transfer last modification time. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product being transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: Id of product being transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Transfers_Cancel (new)
Description :  Cancels the transfer for given transfer Id.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/transfers/{transferName}
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
transferName:
{
Description: Transfer Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: Transfer creation time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Transfer expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Target invoice section Id. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: Target billing account Id. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: Email Id of recipient of transfer. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: Email Id of initiator of transfer. ,
Required: False ,
}
string ,
canceledBy:
{
Description: Email Id who user canceled the transfer. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Transfer last modification time. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product being transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: Id of product being transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Transfers_List (new)
Description :  Lists all transfer's details initiated from given invoice section.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/transfers
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of transfers initiated by caller. ,
Required: False ,
}
[
{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: Transfer creation time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Transfer expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Target invoice section Id. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: Target billing account Id. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: Email Id of recipient of transfer. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: Email Id of initiator of transfer. ,
Required: False ,
}
string ,
canceledBy:
{
Description: Email Id who user canceled the transfer. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Transfer last modification time. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product being transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: Id of product being transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

POST:  /providers/Microsoft.Billing/transfers/{transferName}/acceptTransfer
{
transferName:
{
Description: Transfer Name. ,
Required: True ,
}
string ,
body:
{
Description: Accept transfer parameters. ,
Required: True ,
}
{
properties:
{
Description: Request parameters to accept transfer. ,
Required: False ,
}
{
productDetails:
{
Description: Request parameters to accept transfer. ,
Required: False ,
}
[
{
productType:
{
Description: Type of the product to be transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: Id of product to be transferred. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: Transfer creation time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Transfer expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
allowedProductType:
{
Description: Type of subscriptions that can be transferred. ,
Required: False ,
}
[
string ,
]
,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: Email Id of recipient of transfer. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: Email Id of initiator of transfer. ,
Required: False ,
}
string ,
canceledBy:
{
Description: Email Id who user canceled the transfer. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Transfer last modification time. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product being transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: Id of product being transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

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

⚼ Request

POST:  /providers/Microsoft.Billing/transfers/{transferName}/declineTransfer
{
transferName:
{
Description: Transfer Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: Transfer creation time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Transfer expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
allowedProductType:
{
Description: Type of subscriptions that can be transferred. ,
Required: False ,
}
[
string ,
]
,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: Email Id of recipient of transfer. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: Email Id of initiator of transfer. ,
Required: False ,
}
string ,
canceledBy:
{
Description: Email Id who user canceled the transfer. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Transfer last modification time. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product being transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: Id of product being transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
RecipientTransfers_Get (new)
Description :  Gets the transfer with given transfer Id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/transfers/{transferName}/
{
transferName:
{
Description: Transfer Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: Transfer creation time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Transfer expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
allowedProductType:
{
Description: Type of subscriptions that can be transferred. ,
Required: False ,
}
[
string ,
]
,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: Email Id of recipient of transfer. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: Email Id of initiator of transfer. ,
Required: False ,
}
string ,
canceledBy:
{
Description: Email Id who user canceled the transfer. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Transfer last modification time. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product being transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: Id of product being transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of transfers received by caller. ,
Required: False ,
}
[
{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: Transfer creation time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Transfer expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
allowedProductType:
{
Description: Type of subscriptions that can be transferred. ,
Required: False ,
}
[
string ,
]
,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: Email Id of recipient of transfer. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: Email Id of initiator of transfer. ,
Required: False ,
}
string ,
canceledBy:
{
Description: Email Id who user canceled the transfer. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Transfer last modification time. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product being transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: Id of product being transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of billing operations supported by the Microsoft.Billing resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.Billing. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Invoice, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
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 ,
}
,
}
BillingPermissions_ListByBillingAccount (new)
Description :  Lists all billing permissions for the caller under a billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/providers/Microsoft.Billing/billingPermissions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
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 do ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions the caller is not allowed to do ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_ListByCustomers (new)
Description :  Lists all billing permissions for the caller under customer.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/providers/Microsoft.Billing/billingPermissions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
customerName:
{
Description: Customer Id. ,
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 do ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions the caller is not allowed to do ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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 all billing permissions for the caller under invoice section.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Billing/billingPermissions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
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 do ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions the caller is not allowed to do ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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 all billingPermissions for the caller has for a billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Billing/billingPermissions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
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 do ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions the caller is not allowed to do ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_GetByBillingAccountName (new)
Description :  Gets the role definition for a role
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/providers/Microsoft.Billing/billingRoleDefinitions/{billingRoleDefinitionName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingRoleDefinitionName:
{
Description: role definition id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The role definition for a role. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
{
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 do ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions the caller is not allowed to do ,
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 ,
}
,
}
BillingRoleDefinitions_GetByInvoiceSectionName (new)
Description :  Gets the role definition for a role
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Billing/billingRoleDefinitions/{billingRoleDefinitionName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
billingRoleDefinitionName:
{
Description: role definition id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The role definition for a role. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
{
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 do ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions the caller is not allowed to do ,
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 ,
}
,
}
BillingRoleDefinitions_GetByBillingProfileName (new)
Description :  Gets the role definition for a role
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Billing/billingRoleDefinitions/{billingRoleDefinitionName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
billingRoleDefinitionName:
{
Description: role definition id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The role definition for a role. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
{
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 do ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions the caller is not allowed to do ,
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 ,
}
,
}
BillingRoleDefinitions_ListByBillingAccountName (new)
Description :  Lists the role definition for a billing account
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/providers/Microsoft.Billing/billingRoleDefinitions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of role definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The role definition for a role. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
{
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 do ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions the caller is not allowed to do ,
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 ,
}
,
}
BillingRoleDefinitions_ListByInvoiceSectionName (new)
Description :  Lists the role definition for an invoice Section
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Billing/billingRoleDefinitions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of role definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The role definition for a role. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
{
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 do ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions the caller is not allowed to do ,
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 ,
}
,
}
BillingRoleDefinitions_ListByBillingProfileName (new)
Description :  Lists the role definition for a Billing Profile
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Billing/billingRoleDefinitions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of role definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The role definition for a role. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
{
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 do ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions the caller is not allowed to do ,
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 ,
}
,
}
BillingRoleAssignments_GetByBillingAccount (new)
Description :  Get the role assignment for the caller
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/providers/Microsoft.Billing/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: role assignment id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The role assignment the caller has ,
Required: False ,
}
{
createdOn:
{
Description: the date the role assignment is created ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: the creator's tenant Id ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: the creator's principal Id ,
Required: False ,
}
string ,
name:
{
Description: the name of the role assignment ,
Required: False ,
}
string ,
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
roleDefinitionName:
{
Description: The role definition id ,
Required: False ,
}
string ,
scope:
{
Description: The scope the role get assigned to ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_DeleteByBillingAccountName (new)
Description :  Delete the role assignment on this billing account
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/providers/Microsoft.Billing/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: role assignment id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The role assignment the caller has ,
Required: False ,
}
{
createdOn:
{
Description: the date the role assignment is created ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: the creator's tenant Id ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: the creator's principal Id ,
Required: False ,
}
string ,
name:
{
Description: the name of the role assignment ,
Required: False ,
}
string ,
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
roleDefinitionName:
{
Description: The role definition id ,
Required: False ,
}
string ,
scope:
{
Description: The scope the role get assigned to ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_GetByInvoiceSectionName (new)
Description :  Get the role assignment for the caller on the invoice Section
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Billing/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: role assignment id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The role assignment the caller has ,
Required: False ,
}
{
createdOn:
{
Description: the date the role assignment is created ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: the creator's tenant Id ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: the creator's principal Id ,
Required: False ,
}
string ,
name:
{
Description: the name of the role assignment ,
Required: False ,
}
string ,
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
roleDefinitionName:
{
Description: The role definition id ,
Required: False ,
}
string ,
scope:
{
Description: The scope the role get assigned to ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_DeleteByInvoiceSectionName (new)
Description :  Delete the role assignment on the invoice Section
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Billing/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: role assignment id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The role assignment the caller has ,
Required: False ,
}
{
createdOn:
{
Description: the date the role assignment is created ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: the creator's tenant Id ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: the creator's principal Id ,
Required: False ,
}
string ,
name:
{
Description: the name of the role assignment ,
Required: False ,
}
string ,
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
roleDefinitionName:
{
Description: The role definition id ,
Required: False ,
}
string ,
scope:
{
Description: The scope the role get assigned to ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_GetByBillingProfileName (new)
Description :  Get the role assignment for the caller on the Billing Profile
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Billing/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: role assignment id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The role assignment the caller has ,
Required: False ,
}
{
createdOn:
{
Description: the date the role assignment is created ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: the creator's tenant Id ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: the creator's principal Id ,
Required: False ,
}
string ,
name:
{
Description: the name of the role assignment ,
Required: False ,
}
string ,
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
roleDefinitionName:
{
Description: The role definition id ,
Required: False ,
}
string ,
scope:
{
Description: The scope the role get assigned to ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_DeleteByBillingProfileName (new)
Description :  Delete the role assignment on this Billing Profile
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Billing/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: role assignment id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The role assignment the caller has ,
Required: False ,
}
{
createdOn:
{
Description: the date the role assignment is created ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: the creator's tenant Id ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: the creator's principal Id ,
Required: False ,
}
string ,
name:
{
Description: the name of the role assignment ,
Required: False ,
}
string ,
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
roleDefinitionName:
{
Description: The role definition id ,
Required: False ,
}
string ,
scope:
{
Description: The scope the role get assigned to ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_ListByBillingAccountName (new)
Description :  Get the role assignments on the Billing Account
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/providers/Microsoft.Billing/billingRoleAssignments
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list role assignments ,
Required: False ,
}
[
{
properties:
{
Description: The role assignment the caller has ,
Required: False ,
}
{
createdOn:
{
Description: the date the role assignment is created ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: the creator's tenant Id ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: the creator's principal Id ,
Required: False ,
}
string ,
name:
{
Description: the name of the role assignment ,
Required: False ,
}
string ,
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
roleDefinitionName:
{
Description: The role definition id ,
Required: False ,
}
string ,
scope:
{
Description: The scope the role get assigned to ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_AddByBillingAccountName (new)
Description :  The operation to add a role assignment to a billing account.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/providers/Microsoft.Billing/createBillingRoleAssignment
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to add a role assignment. ,
Required: True ,
}
{
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
billingRoleDefinitionId:
{
Description: The role definition id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
value:
{
Description: The list role assignments ,
Required: False ,
}
[
{
properties:
{
Description: The role assignment the caller has ,
Required: False ,
}
{
createdOn:
{
Description: the date the role assignment is created ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: the creator's tenant Id ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: the creator's principal Id ,
Required: False ,
}
string ,
name:
{
Description: the name of the role assignment ,
Required: False ,
}
string ,
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
roleDefinitionName:
{
Description: The role definition id ,
Required: False ,
}
string ,
scope:
{
Description: The scope the role get assigned to ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_ListByInvoiceSectionName (new)
Description :  Get the role assignments on the invoice Section
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Billing/billingRoleAssignments
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list role assignments ,
Required: False ,
}
[
{
properties:
{
Description: The role assignment the caller has ,
Required: False ,
}
{
createdOn:
{
Description: the date the role assignment is created ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: the creator's tenant Id ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: the creator's principal Id ,
Required: False ,
}
string ,
name:
{
Description: the name of the role assignment ,
Required: False ,
}
string ,
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
roleDefinitionName:
{
Description: The role definition id ,
Required: False ,
}
string ,
scope:
{
Description: The scope the role get assigned to ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_AddByInvoiceSectionName (new)
Description :  The operation to add a role assignment to a invoice Section.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Billing/createBillingRoleAssignment
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to add a role assignment. ,
Required: True ,
}
{
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
billingRoleDefinitionId:
{
Description: The role definition id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
value:
{
Description: The list role assignments ,
Required: False ,
}
[
{
properties:
{
Description: The role assignment the caller has ,
Required: False ,
}
{
createdOn:
{
Description: the date the role assignment is created ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: the creator's tenant Id ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: the creator's principal Id ,
Required: False ,
}
string ,
name:
{
Description: the name of the role assignment ,
Required: False ,
}
string ,
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
roleDefinitionName:
{
Description: The role definition id ,
Required: False ,
}
string ,
scope:
{
Description: The scope the role get assigned to ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_ListByBillingProfileName (new)
Description :  Get the role assignments on the Billing Profile
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Billing/billingRoleAssignments
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list role assignments ,
Required: False ,
}
[
{
properties:
{
Description: The role assignment the caller has ,
Required: False ,
}
{
createdOn:
{
Description: the date the role assignment is created ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: the creator's tenant Id ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: the creator's principal Id ,
Required: False ,
}
string ,
name:
{
Description: the name of the role assignment ,
Required: False ,
}
string ,
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
roleDefinitionName:
{
Description: The role definition id ,
Required: False ,
}
string ,
scope:
{
Description: The scope the role get assigned to ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_AddByBillingProfileName (new)
Description :  The operation to add a role assignment to a billing profile.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Billing/createBillingRoleAssignment
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to add a role assignment. ,
Required: True ,
}
{
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
billingRoleDefinitionId:
{
Description: The role definition id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
value:
{
Description: The list role assignments ,
Required: False ,
}
[
{
properties:
{
Description: The role assignment the caller has ,
Required: False ,
}
{
createdOn:
{
Description: the date the role assignment is created ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: the creator's tenant Id ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: the creator's principal Id ,
Required: False ,
}
string ,
name:
{
Description: the name of the role assignment ,
Required: False ,
}
string ,
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
roleDefinitionName:
{
Description: The role definition id ,
Required: False ,
}
string ,
scope:
{
Description: The scope the role get assigned to ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_ListByBillingAccountName (new)
Description :  Lists all agreements for a billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
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: An agreement. ,
Required: False ,
}
{
agreementLink:
{
Description: The link to the agreement. ,
Required: False ,
}
string ,
effectiveDate:
{
Description: Effective date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
participants:
{
Description: Participants or signer of the agreement. ,
Required: False ,
}
[
{
status:
{
Description: The signing status ,
Required: False ,
}
string ,
statusDate:
{
Description: The date when status got changed. ,
Format: date-time ,
Required: False ,
}
string ,
email:
{
Description: The email address of the participant or signer. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The agreement status ,
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 ,
}
,
}
Agreements_Get (new)
Description :  Get the agreement by name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements/{agreementName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
agreementName:
{
Description: Agreement Id. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the participants. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: An agreement. ,
Required: False ,
}
{
agreementLink:
{
Description: The link to the agreement. ,
Required: False ,
}
string ,
effectiveDate:
{
Description: Effective date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
participants:
{
Description: Participants or signer of the agreement. ,
Required: False ,
}
[
{
status:
{
Description: The signing status ,
Required: False ,
}
string ,
statusDate:
{
Description: The date when status got changed. ,
Format: date-time ,
Required: False ,
}
string ,
email:
{
Description: The email address of the participant or signer. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The agreement status ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
LineOfCredits_Get (new)
Description :  Get the current line of credit.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingAccounts/default/lineOfCredit/default
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A line of credit. ,
Required: False ,
}
{
creditLimit:
{
Description: The current credit limit. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
reason:
{
Description: The reason for the line of credit status when not approved. ,
Required: False ,
}
string ,
remainingBalance:
{
Description: Remaining balance. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
status:
{
Description: The line of credit status. ,
Enum:
{
Approved: No description available. ,
Rejected: 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 ,
}
,
}
LineOfCredits_Update (new)
Description :  Increase the current line of credit.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingAccounts/default/lineOfCredit/default
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the increase line of credit operation. ,
Required: True ,
}
{
properties:
{
Description: A line of credit. ,
Required: False ,
}
{
creditLimit:
{
Description: The current credit limit. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
reason:
{
Description: The reason for the line of credit status when not approved. ,
Required: False ,
}
string ,
remainingBalance:
{
Description: Remaining balance. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
status:
{
Description: The line of credit status. ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A line of credit. ,
Required: False ,
}
{
creditLimit:
{
Description: The current credit limit. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
reason:
{
Description: The reason for the line of credit status when not approved. ,
Required: False ,
}
string ,
remainingBalance:
{
Description: Remaining balance. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
status:
{
Description: The line of credit status. ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result. ,
}
string ,
retry-after:
{
Description: Recommends the retryable time after receiving this. ,
}
integer ,
azure-asyncoperation:
{
Description: URI to poll for the operation status ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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 all billing accounts for which a user has access.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the invoiceSections and billingProfiles. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing accounts. ,
Required: False ,
}
[
{
properties:
{
Description: A billing account. ,
Required: False ,
}
{
displayName:
{
Description: The billing account name. ,
Required: False ,
}
string ,
accountType:
{
Description: The billing account Type. ,
Enum:
{
Organization: No description available. ,
Enrollment: No description available. ,
}
,
Required: False ,
}
enum ,
address:
{
Description: The address associated with billing account. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
company:
{
Description: Company Name. ,
Required: False ,
}
string ,
country:
{
Description: Country Name. ,
Required: False ,
}
string ,
invoiceSections:
{
Description: The invoice sections associated to the billing account. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: The InvoiceSection. ,
Required: False ,
}
{
displayName:
{
Description: The name of the InvoiceSection. ,
Required: False ,
}
string ,
billingProfiles:
{
Description: The billing profiles associated to the billing account. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
billingProfiles:
{
Description: The billing profiles associated to the billing account. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
enrollmentDetails:
{
Description: The details about the associated legacy enrollment. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
startDate:
{
Description: Enrollment Start Date ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Enrollment End Date ,
Format: date-time ,
Required: False ,
}
string ,
currency:
{
Description: The currency associated with enrollment ,
Required: False ,
}
string ,
channel:
{
Description: The channel for Enrollment ,
Required: False ,
}
string ,
policies:
{
Description: The attributes associated with legacy enrollment. ,
Required: False ,
}
{
accountOwnerViewCharges:
{
Description: The accountOwnerViewCharges flag for Enrollment ,
Required: False ,
}
boolean ,
departmentAdminViewCharges:
{
Description: The departmentAdminViewCharges flag for Enrollment ,
Required: False ,
}
boolean ,
marketplacesEnabled:
{
Description: The marketplaces flag for Enrollment ,
Required: False ,
}
boolean ,
reservedInstancesEnabled:
{
Description: The reserved instances flag for Enrollment ,
Required: False ,
}
boolean ,
}
,
language:
{
Description: The language for Enrollment ,
Required: False ,
}
string ,
countryCode:
{
Description: The countryCode for Enrollment ,
Required: False ,
}
string ,
status:
{
Description: Enrollment status ,
Required: False ,
}
string ,
billingCycle:
{
Description: Enrollment billing cycle ,
Required: False ,
}
string ,
}
,
departments:
{
Description: The departments associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: A department. ,
Required: False ,
}
{
departmentName:
{
Description: The name for department. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
status:
{
Description: The status for 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: An account. ,
Required: False ,
}
{
accountName:
{
Description: The account name. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The account owner ,
Required: False ,
}
string ,
status:
{
Description: The status for account. ,
Required: False ,
}
string ,
startDate:
{
Description: Account Start Date ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Account End Date ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
enrollmentAccounts:
{
Description: The accounts associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: An account. ,
Required: False ,
}
{
accountName:
{
Description: The account name. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The account owner ,
Required: False ,
}
string ,
status:
{
Description: The status for account. ,
Required: False ,
}
string ,
startDate:
{
Description: Account Start Date ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Account End Date ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
hasReadAccess:
{
Description: Specifies whether the user has read access on billing account. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
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 ,
}
,
}
BillingAccounts_Get (removed)
Description :  Get the billing account by id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the invoiceSections and billingProfiles. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A billing account. ,
Required: False ,
}
{
displayName:
{
Description: The billing account name. ,
Required: False ,
}
string ,
accountType:
{
Description: The billing account Type. ,
Enum:
{
Organization: No description available. ,
Enrollment: No description available. ,
}
,
Required: False ,
}
enum ,
address:
{
Description: The address associated with billing account. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
company:
{
Description: Company Name. ,
Required: False ,
}
string ,
country:
{
Description: Country Name. ,
Required: False ,
}
string ,
invoiceSections:
{
Description: The invoice sections associated to the billing account. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: The InvoiceSection. ,
Required: False ,
}
{
displayName:
{
Description: The name of the InvoiceSection. ,
Required: False ,
}
string ,
billingProfiles:
{
Description: The billing profiles associated to the billing account. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
billingProfiles:
{
Description: The billing profiles associated to the billing account. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
enrollmentDetails:
{
Description: The details about the associated legacy enrollment. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
startDate:
{
Description: Enrollment Start Date ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Enrollment End Date ,
Format: date-time ,
Required: False ,
}
string ,
currency:
{
Description: The currency associated with enrollment ,
Required: False ,
}
string ,
channel:
{
Description: The channel for Enrollment ,
Required: False ,
}
string ,
policies:
{
Description: The attributes associated with legacy enrollment. ,
Required: False ,
}
{
accountOwnerViewCharges:
{
Description: The accountOwnerViewCharges flag for Enrollment ,
Required: False ,
}
boolean ,
departmentAdminViewCharges:
{
Description: The departmentAdminViewCharges flag for Enrollment ,
Required: False ,
}
boolean ,
marketplacesEnabled:
{
Description: The marketplaces flag for Enrollment ,
Required: False ,
}
boolean ,
reservedInstancesEnabled:
{
Description: The reserved instances flag for Enrollment ,
Required: False ,
}
boolean ,
}
,
language:
{
Description: The language for Enrollment ,
Required: False ,
}
string ,
countryCode:
{
Description: The countryCode for Enrollment ,
Required: False ,
}
string ,
status:
{
Description: Enrollment status ,
Required: False ,
}
string ,
billingCycle:
{
Description: Enrollment billing cycle ,
Required: False ,
}
string ,
}
,
departments:
{
Description: The departments associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: A department. ,
Required: False ,
}
{
departmentName:
{
Description: The name for department. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
status:
{
Description: The status for 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: An account. ,
Required: False ,
}
{
accountName:
{
Description: The account name. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The account owner ,
Required: False ,
}
string ,
status:
{
Description: The status for account. ,
Required: False ,
}
string ,
startDate:
{
Description: Account Start Date ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Account End Date ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
enrollmentAccounts:
{
Description: The accounts associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: An account. ,
Required: False ,
}
{
accountName:
{
Description: The account name. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The account owner ,
Required: False ,
}
string ,
status:
{
Description: The status for account. ,
Required: False ,
}
string ,
startDate:
{
Description: Account Start Date ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Account End Date ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
hasReadAccess:
{
Description: Specifies whether the user has read access on billing account. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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 :  The operation to update a billing account.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the update billing account operation. ,
Required: True ,
}
{
properties:
{
Description: A billing property. ,
Required: False ,
}
{
displayName:
{
Description: The billing account name. ,
Required: False ,
}
string ,
accountType:
{
Description: The billing account Type. ,
Enum:
{
Organization: No description available. ,
Enrollment: No description available. ,
}
,
Required: False ,
}
enum ,
address:
{
Description: The address associated with billing account. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
company:
{
Description: Company Name. ,
Required: False ,
}
string ,
country:
{
Description: Country Name. ,
Required: False ,
}
string ,
invoiceSections:
{
Description: The invoice sections associated to the billing account. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: The InvoiceSection. ,
Required: False ,
}
{
displayName:
{
Description: The name of the InvoiceSection. ,
Required: False ,
}
string ,
billingProfiles:
{
Description: The billing profiles associated to the billing account. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
billingProfiles:
{
Description: The billing profiles associated to the billing account. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
enrollmentDetails:
{
Description: The details about the associated legacy enrollment. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
startDate:
{
Description: Enrollment Start Date ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Enrollment End Date ,
Format: date-time ,
Required: False ,
}
string ,
currency:
{
Description: The currency associated with enrollment ,
Required: False ,
}
string ,
channel:
{
Description: The channel for Enrollment ,
Required: False ,
}
string ,
policies:
{
Description: The attributes associated with legacy enrollment. ,
Required: False ,
}
{
accountOwnerViewCharges:
{
Description: The accountOwnerViewCharges flag for Enrollment ,
Required: False ,
}
boolean ,
departmentAdminViewCharges:
{
Description: The departmentAdminViewCharges flag for Enrollment ,
Required: False ,
}
boolean ,
marketplacesEnabled:
{
Description: The marketplaces flag for Enrollment ,
Required: False ,
}
boolean ,
reservedInstancesEnabled:
{
Description: The reserved instances flag for Enrollment ,
Required: False ,
}
boolean ,
}
,
language:
{
Description: The language for Enrollment ,
Required: False ,
}
string ,
countryCode:
{
Description: The countryCode for Enrollment ,
Required: False ,
}
string ,
status:
{
Description: Enrollment status ,
Required: False ,
}
string ,
billingCycle:
{
Description: Enrollment billing cycle ,
Required: False ,
}
string ,
}
,
departments:
{
Description: The departments associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: A department. ,
Required: False ,
}
{
departmentName:
{
Description: The name for department. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
status:
{
Description: The status for 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: An account. ,
Required: False ,
}
{
accountName:
{
Description: The account name. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The account owner ,
Required: False ,
}
string ,
status:
{
Description: The status for account. ,
Required: False ,
}
string ,
startDate:
{
Description: Account Start Date ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Account End Date ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
enrollmentAccounts:
{
Description: The accounts associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: An account. ,
Required: False ,
}
{
accountName:
{
Description: The account name. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The account owner ,
Required: False ,
}
string ,
status:
{
Description: The status for account. ,
Required: False ,
}
string ,
startDate:
{
Description: Account Start Date ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Account End Date ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
hasReadAccess:
{
Description: Specifies whether the user has read access on billing account. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A billing account. ,
Required: False ,
}
{
displayName:
{
Description: The billing account name. ,
Required: False ,
}
string ,
accountType:
{
Description: The billing account Type. ,
Enum:
{
Organization: No description available. ,
Enrollment: No description available. ,
}
,
Required: False ,
}
enum ,
address:
{
Description: The address associated with billing account. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
company:
{
Description: Company Name. ,
Required: False ,
}
string ,
country:
{
Description: Country Name. ,
Required: False ,
}
string ,
invoiceSections:
{
Description: The invoice sections associated to the billing account. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: The InvoiceSection. ,
Required: False ,
}
{
displayName:
{
Description: The name of the InvoiceSection. ,
Required: False ,
}
string ,
billingProfiles:
{
Description: The billing profiles associated to the billing account. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
billingProfiles:
{
Description: The billing profiles associated to the billing account. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
enrollmentDetails:
{
Description: The details about the associated legacy enrollment. By default this is not populated, unless it's specified in $expand. ,
Required: False ,
}
{
startDate:
{
Description: Enrollment Start Date ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Enrollment End Date ,
Format: date-time ,
Required: False ,
}
string ,
currency:
{
Description: The currency associated with enrollment ,
Required: False ,
}
string ,
channel:
{
Description: The channel for Enrollment ,
Required: False ,
}
string ,
policies:
{
Description: The attributes associated with legacy enrollment. ,
Required: False ,
}
{
accountOwnerViewCharges:
{
Description: The accountOwnerViewCharges flag for Enrollment ,
Required: False ,
}
boolean ,
departmentAdminViewCharges:
{
Description: The departmentAdminViewCharges flag for Enrollment ,
Required: False ,
}
boolean ,
marketplacesEnabled:
{
Description: The marketplaces flag for Enrollment ,
Required: False ,
}
boolean ,
reservedInstancesEnabled:
{
Description: The reserved instances flag for Enrollment ,
Required: False ,
}
boolean ,
}
,
language:
{
Description: The language for Enrollment ,
Required: False ,
}
string ,
countryCode:
{
Description: The countryCode for Enrollment ,
Required: False ,
}
string ,
status:
{
Description: Enrollment status ,
Required: False ,
}
string ,
billingCycle:
{
Description: Enrollment billing cycle ,
Required: False ,
}
string ,
}
,
departments:
{
Description: The departments associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: A department. ,
Required: False ,
}
{
departmentName:
{
Description: The name for department. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
status:
{
Description: The status for 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: An account. ,
Required: False ,
}
{
accountName:
{
Description: The account name. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The account owner ,
Required: False ,
}
string ,
status:
{
Description: The status for account. ,
Required: False ,
}
string ,
startDate:
{
Description: Account Start Date ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Account End Date ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
enrollmentAccounts:
{
Description: The accounts associated to the enrollment. ,
Required: False ,
}
[
{
properties:
{
Description: An account. ,
Required: False ,
}
{
accountName:
{
Description: The account name. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The account owner ,
Required: False ,
}
string ,
status:
{
Description: The status for account. ,
Required: False ,
}
string ,
startDate:
{
Description: Account Start Date ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Account End Date ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
hasReadAccess:
{
Description: Specifies whether the user has read access on billing account. ,
Required: False ,
}
boolean ,
}
,
}

⚐ 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 ,
}
,
}
PaymentMethods_ListByBillingAccountName (removed)
Description :  Lists the Payment Methods by billing account Id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/paymentMethods
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Addresses_Validate (removed)
Description :  Validates the address.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/validateAddress
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
address:
{
Required: True ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
AvailableBalances_GetByBillingProfile (removed)
Description :  The latest available credit balance for a given billingAccountName and billingProfileName.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/availableBalance/default
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
PaymentMethods_ListByBillingProfileName (removed)
Description :  Lists the Payment Methods by billing profile Id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/paymentMethods
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
BillingProfiles_ListByBillingAccountName (removed)
Description :  Lists all billing profiles for a user which that user has access to.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the invoiceSections. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing profiles. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
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 ,
}
,
}
BillingProfiles_Create (removed)
Description :  The operation to create a BillingProfile.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create BillingProfile operation. ,
Required: True ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
enableAzureSKUs:
{
Description: Azure skus to enable for this billing profile.. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result ,
}
string ,
retry-after:
{
Description: Recommends the retryable time after receiving this. ,
}
integer ,
azure-asyncoperation:
{
Description: URI to poll for the operation status ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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 :  Get the billing profile by id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the invoiceSections. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
BillingProfiles_Update (removed)
Description :  The operation to update a billing profile.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the update billing profile operation. ,
Required: True ,
}
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Customers_ListByBillingAccountName (removed)
Description :  Lists all customers which the current user can work with on-behalf of a partner.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter using hasPermission('{permissionId}') to only return customers for which the caller has the specified permission. ,
Required: False ,
}
string ,
$skiptoken:
{
Description: Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of customers. ,
Required: False ,
}
[
{
properties:
{
Description: The customer. ,
Required: False ,
}
{
displayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
resellers:
{
Description: The resellers which are allowed to provide service to this customer. ,
Required: False ,
}
[
{
resellerId:
{
Description: The reseller id. ,
Required: False ,
}
string ,
description:
{
Description: A description of the reseller. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Customers_Get (removed)
Description :  Get the customer by id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
customerName:
{
Description: Customer Id. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand enabledAzureSkus, resellers. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The customer. ,
Required: False ,
}
{
displayName:
{
Description: The name of the customer. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
Required: False ,
}
[
{
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
}
,
]
,
resellers:
{
Description: The resellers which are allowed to provide service to this customer. ,
Required: False ,
}
[
{
resellerId:
{
Description: The reseller id. ,
Required: False ,
}
string ,
description:
{
Description: A description 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 ,
}
,
}
InvoiceSections_ListByBillingAccountName (removed)
Description :  Lists all invoice sections for which a user has access.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the billingProfiles. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of invoice sections. ,
Required: False ,
}
[
{
properties:
{
Description: The InvoiceSection. ,
Required: False ,
}
{
displayName:
{
Description: The name of the InvoiceSection. ,
Required: False ,
}
string ,
billingProfiles:
{
Description: The billing profiles associated to the billing account. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
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 ,
}
,
}
InvoiceSections_Create (removed)
Description :  The operation to create a InvoiceSection.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create InvoiceSection operation. ,
Required: True ,
}
{
displayName:
{
Description: The name of the InvoiceSection. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The billing profile id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The InvoiceSection. ,
Required: False ,
}
{
displayName:
{
Description: The name of the InvoiceSection. ,
Required: False ,
}
string ,
billingProfiles:
{
Description: The billing profiles associated to the billing account. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result ,
}
string ,
retry-after:
{
Description: Recommends the retryable time after receiving this. ,
}
integer ,
azure-asyncoperation:
{
Description: URI to poll for the operation status ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_ListByBillingProfileName (removed)
Description :  Lists all invoice sections under a billing profile for which a user has access.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of invoice sections. ,
Required: False ,
}
[
{
properties:
{
Description: The InvoiceSection. ,
Required: False ,
}
{
displayName:
{
Description: The name of the InvoiceSection. ,
Required: False ,
}
string ,
billingProfiles:
{
Description: The billing profiles associated to the billing account. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
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 ,
}
,
}
InvoiceSections_ListByCreateSubscriptionPermission (removed)
Description :  Lists all invoiceSections with create subscription permission for a user.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/listInvoiceSectionsWithCreateSubscriptionPermission
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the billingProfiles. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of invoice sections. ,
Required: False ,
}
[
{
properties:
{
Description: The InvoiceSection. ,
Required: False ,
}
{
displayName:
{
Description: The name of the InvoiceSection. ,
Required: False ,
}
string ,
billingProfiles:
{
Description: The billing profiles associated to the billing account. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
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 ,
}
,
}
InvoiceSections_Get (removed)
Description :  Get the InvoiceSection by id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the billingProfiles. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The InvoiceSection. ,
Required: False ,
}
{
displayName:
{
Description: The name of the InvoiceSection. ,
Required: False ,
}
string ,
billingProfiles:
{
Description: The billing profiles associated to the billing account. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
InvoiceSections_Update (removed)
Description :  The operation to update a InvoiceSection.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Create InvoiceSection operation. ,
Required: True ,
}
{
properties:
{
Description: The InvoiceSection. ,
Required: False ,
}
{
displayName:
{
Description: The name of the InvoiceSection. ,
Required: False ,
}
string ,
billingProfiles:
{
Description: The billing profiles associated to the billing account. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The InvoiceSection. ,
Required: False ,
}
{
displayName:
{
Description: The name of the InvoiceSection. ,
Required: False ,
}
string ,
billingProfiles:
{
Description: The billing profiles associated to the billing account. ,
Required: False ,
}
[
{
properties:
{
Description: A billing profile. ,
Required: False ,
}
{
displayName:
{
Description: The billing profile name. ,
Required: False ,
}
string ,
poNumber:
{
Description: Purchase order number. ,
Required: False ,
}
string ,
address:
{
Description: Billing address. ,
Required: False ,
}
{
firstName:
{
Description: First Name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last Name. ,
Required: False ,
}
string ,
companyName:
{
Description: Company Name. ,
Required: False ,
}
string ,
addressLine1:
{
Description: Address Line1. ,
Required: False ,
}
string ,
addressLine2:
{
Description: Address Line2. ,
Required: False ,
}
string ,
addressLine3:
{
Description: Address Line3. ,
Required: False ,
}
string ,
city:
{
Description: Address City. ,
Required: False ,
}
string ,
region:
{
Description: Address Region. ,
Required: False ,
}
string ,
country:
{
Description: Country code uses ISO2, 2-digit format. ,
Required: False ,
}
string ,
postalCode:
{
Description: Address Postal Code. ,
Required: False ,
}
string ,
}
,
invoiceEmailOptIn:
{
Description: If the billing profile is opted in to receive invoices via email. ,
Required: False ,
}
boolean ,
isClassic:
{
Description: Is OMS bootstrapped billing profile. ,
Required: False ,
}
boolean ,
invoiceDay:
{
Description: Invoice day. ,
Format: int32 ,
Required: False ,
}
integer ,
currency:
{
Description: The currency associated with the billing profile. ,
Required: False ,
}
string ,
enabledAzureSKUs:
{
Description: Information about the product. ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Departments_ListByBillingAccountName (removed)
Description :  Lists all departments for which a user has access.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the enrollmentAccounts. ,
Required: False ,
}
string ,
$filter:
{
Description: 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 is separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of departments. ,
Required: False ,
}
[
{
properties:
{
Description: A department. ,
Required: False ,
}
{
departmentName:
{
Description: The name for department. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
status:
{
Description: The status for 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: An account. ,
Required: False ,
}
{
accountName:
{
Description: The account name. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The account owner ,
Required: False ,
}
string ,
status:
{
Description: The status for account. ,
Required: False ,
}
string ,
startDate:
{
Description: Account Start Date ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Account End Date ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Departments_Get (removed)
Description :  Get the department by id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
departmentName:
{
Description: Department Id. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the enrollmentAccounts. ,
Required: False ,
}
string ,
$filter:
{
Description: 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 is separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A department. ,
Required: False ,
}
{
departmentName:
{
Description: The name for department. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
status:
{
Description: The status for 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: An account. ,
Required: False ,
}
{
accountName:
{
Description: The account name. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The account owner ,
Required: False ,
}
string ,
status:
{
Description: The status for account. ,
Required: False ,
}
string ,
startDate:
{
Description: Account Start Date ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Account End Date ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
EnrollmentAccounts_ListByBillingAccountName (removed)
Description :  Lists all Enrollment Accounts for which a user has access.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the department. ,
Required: False ,
}
string ,
$filter:
{
Description: 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 is separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
EnrollmentAccounts_GetByEnrollmentAccountId (removed)
Description :  Get the enrollment account by id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
enrollmentAccountName:
{
Description: Enrollment Account Id. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the Department. ,
Required: False ,
}
string ,
$filter:
{
Description: 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 is separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: An account. ,
Required: False ,
}
{
accountName:
{
Description: The account name. ,
Required: False ,
}
string ,
costCenter:
{
Description: The cost center name. ,
Required: False ,
}
string ,
accountOwner:
{
Description: The account owner ,
Required: False ,
}
string ,
status:
{
Description: The status for account. ,
Required: False ,
}
string ,
startDate:
{
Description: Account Start Date ,
Format: date-time ,
Required: False ,
}
string ,
endDate:
{
Description: Account End Date ,
Format: date-time ,
Required: False ,
}
string ,
department:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Invoices_ListByBillingAccountName (removed)
Description :  List of invoices for a billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: Invoice period start date. ,
Required: True ,
}
string ,
periodEndDate:
{
Description: Invoice period end date. ,
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 invoice. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceDate:
{
Description: The date when invoice was created. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Invoice status. ,
Enum:
{
PastDue: No description available. ,
Due: No description available. ,
Paid: No description available. ,
Void: No description available. ,
}
,
Required: False ,
}
enum ,
amountDue:
{
Description: Amount due. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billedAmount:
{
Description: Amount billed. ,
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. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end date of the billing period. ,
Format: date-time ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The billing profile id this invoice belongs to. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The profile name this invoice belongs to. ,
Required: False ,
}
string ,
purchaseOrderNumber:
{
Description: The purchase identifier for the invoice. ,
Required: False ,
}
string ,
documentUrls:
{
Description: List of document urls available to download including invoice and tax documents. ,
Required: False ,
}
[
{
kind:
{
Description: Document type. ,
Enum:
{
Invoice: No description available. ,
VoidNote: No description available. ,
Receipt: No description available. ,
CreditNote: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: Document URL. ,
Required: False ,
}
string ,
}
,
]
,
payments:
{
Description: List of payments. ,
Required: False ,
}
[
{
paymentType:
{
Description: The type of payment. ,
Required: False ,
}
string ,
amount:
{
Description: The paid amount. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
date:
{
Description: The date of the payment. ,
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 ,
}
,
}
PriceSheet_Download (removed)
Description :  Download price sheet for an invoice.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/pricesheet/default/download
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Azure Billing Account ID. ,
Required: True ,
}
string ,
invoiceName:
{
Description: The name of an invoice resource. ,
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 ,
azure-asyncoperation:
{
Description: To get the progress of the operation, call GET operation on the URL in Azure-AsyncOperation header field. ,
}
string ,
odata-entityid:
{
Description: The operation entity Id GUID. ,
}
string ,
}

⚐ Response (200)

{
expiryTime:
{
Description: The time in UTC at which this 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 ,
}
,
}
Invoices_ListByBillingProfile (removed)
Description :  List of invoices for a billing profile.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
periodStartDate:
{
Description: Invoice period start date. ,
Required: True ,
}
string ,
periodEndDate:
{
Description: Invoice period end date. ,
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 invoice. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceDate:
{
Description: The date when invoice was created. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Invoice status. ,
Enum:
{
PastDue: No description available. ,
Due: No description available. ,
Paid: No description available. ,
Void: No description available. ,
}
,
Required: False ,
}
enum ,
amountDue:
{
Description: Amount due. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billedAmount:
{
Description: Amount billed. ,
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. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end date of the billing period. ,
Format: date-time ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The billing profile id this invoice belongs to. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The profile name this invoice belongs to. ,
Required: False ,
}
string ,
purchaseOrderNumber:
{
Description: The purchase identifier for the invoice. ,
Required: False ,
}
string ,
documentUrls:
{
Description: List of document urls available to download including invoice and tax documents. ,
Required: False ,
}
[
{
kind:
{
Description: Document type. ,
Enum:
{
Invoice: No description available. ,
VoidNote: No description available. ,
Receipt: No description available. ,
CreditNote: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: Document URL. ,
Required: False ,
}
string ,
}
,
]
,
payments:
{
Description: List of payments. ,
Required: False ,
}
[
{
paymentType:
{
Description: The type of payment. ,
Required: False ,
}
string ,
amount:
{
Description: The paid amount. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
date:
{
Description: The date of the payment. ,
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 ,
}
,
}
Invoices_Get (removed)
Description :  Get the invoice by name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices/{invoiceName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
invoiceName:
{
Description: Invoice Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: An invoice. ,
Required: False ,
}
{
dueDate:
{
Description: The due date for invoice. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceDate:
{
Description: The date when invoice was created. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Invoice status. ,
Enum:
{
PastDue: No description available. ,
Due: No description available. ,
Paid: No description available. ,
Void: No description available. ,
}
,
Required: False ,
}
enum ,
amountDue:
{
Description: Amount due. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billedAmount:
{
Description: Amount billed. ,
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. ,
Format: date-time ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end date of the billing period. ,
Format: date-time ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The billing profile id this invoice belongs to. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: The profile name this invoice belongs to. ,
Required: False ,
}
string ,
purchaseOrderNumber:
{
Description: The purchase identifier for the invoice. ,
Required: False ,
}
string ,
documentUrls:
{
Description: List of document urls available to download including invoice and tax documents. ,
Required: False ,
}
[
{
kind:
{
Description: Document type. ,
Enum:
{
Invoice: No description available. ,
VoidNote: No description available. ,
Receipt: No description available. ,
CreditNote: No description available. ,
}
,
Required: False ,
}
enum ,
url:
{
Description: Document URL. ,
Required: False ,
}
string ,
}
,
]
,
payments:
{
Description: List of payments. ,
Required: False ,
}
[
{
paymentType:
{
Description: The type of payment. ,
Required: False ,
}
string ,
amount:
{
Description: The paid amount. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
date:
{
Description: The date of the payment. ,
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 ,
}
,
}
BillingSubscriptions_ListByBillingAccountName (removed)
Description :  Lists billing subscriptions by billing account name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing subscriptions summary. ,
Required: False ,
}
[
{
properties:
{
Description: The usage context properties. ,
Required: False ,
}
{
displayName:
{
Description: display name. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
subscriptionBillingStatus:
{
Description: Subscription billing status. ,
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: 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: 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: Billing Profile id to which this product belongs. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing Profile name to which this product belongs. ,
Required: False ,
}
string ,
customerId:
{
Description: Customer id to which this product belongs. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: Display name of customer to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice section id to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice section name to which this product belongs. ,
Required: False ,
}
string ,
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this subscription. ,
Required: False ,
}
{
resellerId:
{
Description: The reseller id. ,
Required: False ,
}
string ,
description:
{
Description: A description of the reseller. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
BillingSubscriptions_ListByBillingProfileName (removed)
Description :  Lists billing subscriptions by billing profile name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingSubscriptions
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing subscriptions summary. ,
Required: False ,
}
[
{
properties:
{
Description: The usage context properties. ,
Required: False ,
}
{
displayName:
{
Description: display name. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
subscriptionBillingStatus:
{
Description: Subscription billing status. ,
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: 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: 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: Billing Profile id to which this product belongs. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing Profile name to which this product belongs. ,
Required: False ,
}
string ,
customerId:
{
Description: Customer id to which this product belongs. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: Display name of customer to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice section id to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice section name to which this product belongs. ,
Required: False ,
}
string ,
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this subscription. ,
Required: False ,
}
{
resellerId:
{
Description: The reseller id. ,
Required: False ,
}
string ,
description:
{
Description: A description of the reseller. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
BillingSubscriptions_ListByCustomerName (removed)
Description :  Lists billing subscription by customer name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/billingSubscriptions
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
customerName:
{
Description: Customer Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing subscriptions summary. ,
Required: False ,
}
[
{
properties:
{
Description: The usage context properties. ,
Required: False ,
}
{
displayName:
{
Description: display name. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
subscriptionBillingStatus:
{
Description: Subscription billing status. ,
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: 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: 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: Billing Profile id to which this product belongs. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing Profile name to which this product belongs. ,
Required: False ,
}
string ,
customerId:
{
Description: Customer id to which this product belongs. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: Display name of customer to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice section id to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice section name to which this product belongs. ,
Required: False ,
}
string ,
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this subscription. ,
Required: False ,
}
{
resellerId:
{
Description: The reseller id. ,
Required: False ,
}
string ,
description:
{
Description: A description of the reseller. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
BillingSubscriptions_GetByCustomerName (removed)
Description :  Get a single billing subscription by name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/billingSubscriptions/{billingSubscriptionName}
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
customerName:
{
Description: Customer Id. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: Billing Subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The usage context properties. ,
Required: False ,
}
{
displayName:
{
Description: display name. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
subscriptionBillingStatus:
{
Description: Subscription billing status. ,
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: 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: 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: Billing Profile id to which this product belongs. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing Profile name to which this product belongs. ,
Required: False ,
}
string ,
customerId:
{
Description: Customer id to which this product belongs. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: Display name of customer to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice section id to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice section name to which this product belongs. ,
Required: False ,
}
string ,
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this subscription. ,
Required: False ,
}
{
resellerId:
{
Description: The reseller id. ,
Required: False ,
}
string ,
description:
{
Description: A description 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 ,
}
,
}
BillingSubscriptions_ListByInvoiceSectionName (removed)
Description :  Lists billing subscription by invoice section name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/billingSubscriptions
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing subscriptions summary. ,
Required: False ,
}
[
{
properties:
{
Description: The usage context properties. ,
Required: False ,
}
{
displayName:
{
Description: display name. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
subscriptionBillingStatus:
{
Description: Subscription billing status. ,
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: 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: 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: Billing Profile id to which this product belongs. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing Profile name to which this product belongs. ,
Required: False ,
}
string ,
customerId:
{
Description: Customer id to which this product belongs. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: Display name of customer to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice section id to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice section name to which this product belongs. ,
Required: False ,
}
string ,
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this subscription. ,
Required: False ,
}
{
resellerId:
{
Description: The reseller id. ,
Required: False ,
}
string ,
description:
{
Description: A description of the reseller. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
BillingSubscriptions_Get (removed)
Description :  Get a single billing subscription by name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/billingSubscriptions/{billingSubscriptionName}
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: Billing Subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The usage context properties. ,
Required: False ,
}
{
displayName:
{
Description: display name. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id. ,
Format: uuid ,
Required: False ,
}
string ,
subscriptionBillingStatus:
{
Description: Subscription billing status. ,
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: 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: 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: Billing Profile id to which this product belongs. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing Profile name to which this product belongs. ,
Required: False ,
}
string ,
customerId:
{
Description: Customer id to which this product belongs. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: Display name of customer to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice section id to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice section name to which this product belongs. ,
Required: False ,
}
string ,
skuId:
{
Description: The sku id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: The sku description. ,
Required: False ,
}
string ,
reseller:
{
Description: Reseller for this subscription. ,
Required: False ,
}
{
resellerId:
{
Description: The reseller id. ,
Required: False ,
}
string ,
description:
{
Description: A description 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 ,
}
,
}
BillingSubscriptions_Transfer (removed)
Description :  Transfers the subscription from one invoice section to another within a billing account.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/billingSubscriptions/{billingSubscriptionName}/transfer
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: Billing Subscription Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Transfer Billing Subscription operation. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: False ,
}
string ,
destinationBillingProfileId:
{
Description: The destination billing profile id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Request parameters to transfer billing subscription. ,
Required: False ,
}
{
billingSubscriptionName:
{
Description: The destination billing subscription id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result. ,
}
string ,
retry-after:
{
Description: Recommends the retryable time after receiving this. ,
}
integer ,
azure-asyncoperation:
{
Description: URI to poll for the operation status ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
BillingSubscriptions_ValidateTransfer (removed)
Description :  Validates the transfer of billing subscriptions across invoice sections.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/billingSubscriptions/{billingSubscriptionName}/validateTransferEligibility
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
billingSubscriptionName:
{
Description: Billing Subscription Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Transfer Billing Subscription operation. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: False ,
}
string ,
destinationBillingProfileId:
{
Description: The destination billing profile id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
isTransferEligible:
{
Description: Specifies whether the transfer is eligible or not. ,
Required: False ,
}
boolean ,
errorDetails:
{
Description: Validation error details. ,
Required: False ,
}
{
code:
{
Description: Error code for the product transfer validation. ,
Enum:
{
InvalidSource: No description available. ,
SubscriptionNotActive: No description available. ,
InsufficientPermissionOnSource: No description available. ,
InsufficientPermissionOnDestination: No description available. ,
DestinationBillingProfilePastDue: No description available. ,
SubscriptionTypeNotSupported: No description available. ,
CrossBillingAccountNotAllowed: No description available. ,
NotAvailableForDestinationMarket: 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 ,
}
,
}
Products_ListByBillingAccountName (removed)
Description :  Lists products by billing account name.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of products summary. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the product summary. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date of purchase. ,
Format: date-time ,
Required: False ,
}
string ,
productTypeId:
{
Description: The product type id. ,
Required: False ,
}
string ,
productType:
{
Description: The type of product. ,
Required: False ,
}
string ,
status:
{
Description: Product status. ,
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: end date. ,
Format: date-time ,
Required: False ,
}
string ,
billingFrequency:
{
Description: Billing frequency. ,
Enum:
{
OneTime: No description available. ,
Monthly: No description available. ,
UsageBased: No description available. ,
}
,
Required: False ,
}
enum ,
lastCharge:
{
Description: 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 purchased product quantity. ,
Required: False ,
}
number ,
skuId:
{
Description: Sku Id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: Sku description. ,
Required: False ,
}
string ,
availabilityId:
{
Description: Availability Id. ,
Required: False ,
}
string ,
parentProductId:
{
Description: Parent Product Id. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice section id to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice section name to which this product belongs. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing Profile id to which this product belongs. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing Profile name to which this product belongs. ,
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 ,
}
,
}
Products_ListByInvoiceSectionName (removed)
Description :  Lists products by invoice section name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/products
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter by product type. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of products summary. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the product summary. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date of purchase. ,
Format: date-time ,
Required: False ,
}
string ,
productTypeId:
{
Description: The product type id. ,
Required: False ,
}
string ,
productType:
{
Description: The type of product. ,
Required: False ,
}
string ,
status:
{
Description: Product status. ,
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: end date. ,
Format: date-time ,
Required: False ,
}
string ,
billingFrequency:
{
Description: Billing frequency. ,
Enum:
{
OneTime: No description available. ,
Monthly: No description available. ,
UsageBased: No description available. ,
}
,
Required: False ,
}
enum ,
lastCharge:
{
Description: 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 purchased product quantity. ,
Required: False ,
}
number ,
skuId:
{
Description: Sku Id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: Sku description. ,
Required: False ,
}
string ,
availabilityId:
{
Description: Availability Id. ,
Required: False ,
}
string ,
parentProductId:
{
Description: Parent Product Id. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice section id to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice section name to which this product belongs. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing Profile id to which this product belongs. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing Profile name to which this product belongs. ,
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 ,
}
,
}
Products_Get (removed)
Description :  Get a single product by name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/products/{productName}
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
productName:
{
Description: Invoice Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the product summary. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date of purchase. ,
Format: date-time ,
Required: False ,
}
string ,
productTypeId:
{
Description: The product type id. ,
Required: False ,
}
string ,
productType:
{
Description: The type of product. ,
Required: False ,
}
string ,
status:
{
Description: Product status. ,
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: end date. ,
Format: date-time ,
Required: False ,
}
string ,
billingFrequency:
{
Description: Billing frequency. ,
Enum:
{
OneTime: No description available. ,
Monthly: No description available. ,
UsageBased: No description available. ,
}
,
Required: False ,
}
enum ,
lastCharge:
{
Description: 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 purchased product quantity. ,
Required: False ,
}
number ,
skuId:
{
Description: Sku Id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: Sku description. ,
Required: False ,
}
string ,
availabilityId:
{
Description: Availability Id. ,
Required: False ,
}
string ,
parentProductId:
{
Description: Parent Product Id. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice section id to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice section name to which this product belongs. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing Profile id to which this product belongs. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing Profile name to which this product belongs. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Products_Transfer (removed)
Description :  The operation to transfer a Product to another invoice section.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/products/{productName}/transfer
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
productName:
{
Description: Invoice Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Transfer Product operation. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: False ,
}
string ,
destinationBillingProfileId:
{
Description: The destination billing profile id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the product summary. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the product. ,
Required: False ,
}
string ,
purchaseDate:
{
Description: The date of purchase. ,
Format: date-time ,
Required: False ,
}
string ,
productTypeId:
{
Description: The product type id. ,
Required: False ,
}
string ,
productType:
{
Description: The type of product. ,
Required: False ,
}
string ,
status:
{
Description: Product status. ,
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: end date. ,
Format: date-time ,
Required: False ,
}
string ,
billingFrequency:
{
Description: Billing frequency. ,
Enum:
{
OneTime: No description available. ,
Monthly: No description available. ,
UsageBased: No description available. ,
}
,
Required: False ,
}
enum ,
lastCharge:
{
Description: 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 purchased product quantity. ,
Required: False ,
}
number ,
skuId:
{
Description: Sku Id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: Sku description. ,
Required: False ,
}
string ,
availabilityId:
{
Description: Availability Id. ,
Required: False ,
}
string ,
parentProductId:
{
Description: Parent Product Id. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice section id to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice section name to which this product belongs. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing Profile id to which this product belongs. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing Profile name to which this product belongs. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result ,
}
string ,
retry-after:
{
Description: Recommends the retryable time after receiving this. ,
}
integer ,
azure-asyncoperation:
{
Description: URI to poll for the operation status ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Products_ValidateTransfer (removed)
Description :  Validates the transfer of products across invoice sections.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/products/{productName}/validateTransferEligibility
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
productName:
{
Description: Invoice Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Transfer Products operation. ,
Required: True ,
}
{
destinationInvoiceSectionId:
{
Description: The destination invoice section id. ,
Required: False ,
}
string ,
destinationBillingProfileId:
{
Description: The destination billing profile id. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Transactions_ListByBillingAccountName (removed)
Description :  Lists the transactions by billing account name for given start and end date.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/transactions
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
startDate:
{
Description: Start date ,
Required: True ,
}
string ,
endDate:
{
Description: End date ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter by transaction kind. 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 is separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservation transactions summary. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the reservation transaction summary. ,
Required: False ,
}
{
kind:
{
Description: The kind of transaction. Choices are all and reservation. ,
Enum:
{
all: No description available. ,
reservation: No description available. ,
}
,
Required: False ,
}
enum ,
date:
{
Description: The date of reservation transaction. ,
Format: date-time ,
Required: False ,
}
string ,
invoice:
{
Description: Invoice number or 'pending' if not invoiced. ,
Required: False ,
}
string ,
orderId:
{
Description: The reservation order id. ,
Required: False ,
}
string ,
orderName:
{
Description: The reservation order name. ,
Required: False ,
}
string ,
productFamily:
{
Description: The product family. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The product type id. ,
Required: False ,
}
string ,
productType:
{
Description: The type of product. ,
Required: False ,
}
string ,
productDescription:
{
Description: Product description. ,
Required: False ,
}
string ,
transactionType:
{
Description: Transaction types. ,
Enum:
{
Purchase: No description available. ,
Usage Charge: No description available. ,
}
,
Required: False ,
}
enum ,
transactionAmount:
{
Description: Last charge associated with the purchase. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
quantity:
{
Description: Purchase quantity. ,
Format: int32 ,
Required: False ,
}
integer ,
customerId:
{
Description: Customer id to which this product belongs. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: Display name of customer to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice section id to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice section name to which this product belongs. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing Profile id to which this product belongs. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing Profile name to which this product belongs. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription id. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The subscription name. ,
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 ,
}
,
}
Transactions_ListByBillingProfileName (removed)
Description :  Lists the transactions by billing profile name for given start date and end date.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/transactions
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
startDate:
{
Description: Start date ,
Required: True ,
}
string ,
endDate:
{
Description: End date ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter by transaction kind. 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 is separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservation transactions summary. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the reservation transaction summary. ,
Required: False ,
}
{
kind:
{
Description: The kind of transaction. Choices are all and reservation. ,
Enum:
{
all: No description available. ,
reservation: No description available. ,
}
,
Required: False ,
}
enum ,
date:
{
Description: The date of reservation transaction. ,
Format: date-time ,
Required: False ,
}
string ,
invoice:
{
Description: Invoice number or 'pending' if not invoiced. ,
Required: False ,
}
string ,
orderId:
{
Description: The reservation order id. ,
Required: False ,
}
string ,
orderName:
{
Description: The reservation order name. ,
Required: False ,
}
string ,
productFamily:
{
Description: The product family. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The product type id. ,
Required: False ,
}
string ,
productType:
{
Description: The type of product. ,
Required: False ,
}
string ,
productDescription:
{
Description: Product description. ,
Required: False ,
}
string ,
transactionType:
{
Description: Transaction types. ,
Enum:
{
Purchase: No description available. ,
Usage Charge: No description available. ,
}
,
Required: False ,
}
enum ,
transactionAmount:
{
Description: Last charge associated with the purchase. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
quantity:
{
Description: Purchase quantity. ,
Format: int32 ,
Required: False ,
}
integer ,
customerId:
{
Description: Customer id to which this product belongs. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: Display name of customer to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice section id to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice section name to which this product belongs. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing Profile id to which this product belongs. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing Profile name to which this product belongs. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription id. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The subscription name. ,
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 ,
}
,
}
Transactions_ListByCustomerName (removed)
Description :  Lists the transactions by invoice section name for given start date and end date.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/transactions
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
customerName:
{
Description: Customer Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
startDate:
{
Description: Start date ,
Required: True ,
}
string ,
endDate:
{
Description: End date ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter by transaction kind. 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 is separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservation transactions summary. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the reservation transaction summary. ,
Required: False ,
}
{
kind:
{
Description: The kind of transaction. Choices are all and reservation. ,
Enum:
{
all: No description available. ,
reservation: No description available. ,
}
,
Required: False ,
}
enum ,
date:
{
Description: The date of reservation transaction. ,
Format: date-time ,
Required: False ,
}
string ,
invoice:
{
Description: Invoice number or 'pending' if not invoiced. ,
Required: False ,
}
string ,
orderId:
{
Description: The reservation order id. ,
Required: False ,
}
string ,
orderName:
{
Description: The reservation order name. ,
Required: False ,
}
string ,
productFamily:
{
Description: The product family. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The product type id. ,
Required: False ,
}
string ,
productType:
{
Description: The type of product. ,
Required: False ,
}
string ,
productDescription:
{
Description: Product description. ,
Required: False ,
}
string ,
transactionType:
{
Description: Transaction types. ,
Enum:
{
Purchase: No description available. ,
Usage Charge: No description available. ,
}
,
Required: False ,
}
enum ,
transactionAmount:
{
Description: Last charge associated with the purchase. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
quantity:
{
Description: Purchase quantity. ,
Format: int32 ,
Required: False ,
}
integer ,
customerId:
{
Description: Customer id to which this product belongs. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: Display name of customer to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice section id to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice section name to which this product belongs. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing Profile id to which this product belongs. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing Profile name to which this product belongs. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription id. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The subscription name. ,
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 ,
}
,
}
Transactions_ListByInvoiceSectionName (removed)
Description :  Lists the transactions by invoice section name for given start date and end date.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/transactions
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
startDate:
{
Description: Start date ,
Required: True ,
}
string ,
endDate:
{
Description: End date ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter by transaction kind. 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 is separated by a colon (:). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of reservation transactions summary. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the reservation transaction summary. ,
Required: False ,
}
{
kind:
{
Description: The kind of transaction. Choices are all and reservation. ,
Enum:
{
all: No description available. ,
reservation: No description available. ,
}
,
Required: False ,
}
enum ,
date:
{
Description: The date of reservation transaction. ,
Format: date-time ,
Required: False ,
}
string ,
invoice:
{
Description: Invoice number or 'pending' if not invoiced. ,
Required: False ,
}
string ,
orderId:
{
Description: The reservation order id. ,
Required: False ,
}
string ,
orderName:
{
Description: The reservation order name. ,
Required: False ,
}
string ,
productFamily:
{
Description: The product family. ,
Required: False ,
}
string ,
productTypeId:
{
Description: The product type id. ,
Required: False ,
}
string ,
productType:
{
Description: The type of product. ,
Required: False ,
}
string ,
productDescription:
{
Description: Product description. ,
Required: False ,
}
string ,
transactionType:
{
Description: Transaction types. ,
Enum:
{
Purchase: No description available. ,
Usage Charge: No description available. ,
}
,
Required: False ,
}
enum ,
transactionAmount:
{
Description: Last charge associated with the purchase. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
quantity:
{
Description: Purchase quantity. ,
Format: int32 ,
Required: False ,
}
integer ,
customerId:
{
Description: Customer id to which this product belongs. ,
Required: False ,
}
string ,
customerDisplayName:
{
Description: Display name of customer to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice section id to which this product belongs. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice section name to which this product belongs. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing Profile id to which this product belongs. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing Profile name to which this product belongs. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription id. ,
Required: False ,
}
string ,
subscriptionName:
{
Description: The subscription name. ,
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 ,
}
,
}
Policies_GetByBillingProfileName (removed)
Description :  The policy for a given billing account name and billing profile name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/policies/default
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of policy. ,
Required: False ,
}
{
marketplacePurchasesAllowed:
{
Description: The marketplacePurchasesAllowed flag. ,
Required: False ,
}
boolean ,
reservationPurchasesAllowed:
{
Description: The reservationPurchasesAllowed flag. ,
Required: False ,
}
boolean ,
subscriptionOwnerCanViewCharges:
{
Description: The subscriptionOwnerCanViewCharges flag. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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 :  The operation to update a policy.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/policies/default
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the update policy operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of policy. ,
Required: False ,
}
{
marketplacePurchasesAllowed:
{
Description: The marketplacePurchasesAllowed flag. ,
Required: False ,
}
boolean ,
reservationPurchasesAllowed:
{
Description: The reservationPurchasesAllowed flag. ,
Required: False ,
}
boolean ,
subscriptionOwnerCanViewCharges:
{
Description: The subscriptionOwnerCanViewCharges flag. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of policy. ,
Required: False ,
}
{
marketplacePurchasesAllowed:
{
Description: The marketplacePurchasesAllowed flag. ,
Required: False ,
}
boolean ,
reservationPurchasesAllowed:
{
Description: The reservationPurchasesAllowed flag. ,
Required: False ,
}
boolean ,
subscriptionOwnerCanViewCharges:
{
Description: The subscriptionOwnerCanViewCharges flag. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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 billing property by subscription Id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingProperty
{
subscriptionId:
{
Description: Azure Subscription Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A billing property. ,
Required: False ,
}
{
billingTenantId:
{
Description: Billing tenant Id. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: Billing account Id. ,
Required: False ,
}
string ,
billingAccountName:
{
Description: Billing account name. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Billing profile Id. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Billing profile name. ,
Required: False ,
}
string ,
costCenter:
{
Description: Cost center name. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Invoice Section Id. ,
Required: False ,
}
string ,
invoiceSectionName:
{
Description: Invoice Section name. ,
Required: False ,
}
string ,
productId:
{
Description: Product Id. ,
Required: False ,
}
string ,
productName:
{
Description: Product name. ,
Required: False ,
}
string ,
skuId:
{
Description: SKU Id. ,
Required: False ,
}
string ,
skuDescription:
{
Description: SKU description. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_UpdateAutoRenewByBillingAccountName (removed)
Description :  Cancel auto renew for product by product id and billing account name
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products/{productName}/updateAutoRenew
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
productName:
{
Description: Invoice Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
body:
{
Description: Update auto renew request parameters. ,
Required: True ,
}
{
autoRenew:
{
Description: Request parameters to update auto renew policy a product. ,
Enum:
{
true: No description available. ,
false: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Summary of update auto renew operation summary properties ,
Required: False ,
}
{
endDate:
{
Description: The end date of this asset ,
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 ,
}
,
}
Products_UpdateAutoRenewByInvoiceSectionName (removed)
Description :  Cancel auto renew for product by product id and invoice section name
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/products/{productName}/updateAutoRenew
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
productName:
{
Description: Invoice Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
body:
{
Description: Update auto renew request parameters. ,
Required: True ,
}
{
autoRenew:
{
Description: Request parameters to update auto renew policy a product. ,
Enum:
{
true: No description available. ,
false: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Summary of update auto renew operation summary properties ,
Required: False ,
}
{
endDate:
{
Description: The end date of this asset ,
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 ,
}
,
}
InvoiceSections_ElevateToBillingProfile (removed)
Description :  Elevates the caller's access to match their billing profile access.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/elevate
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Transfers_Initiate (removed)
Description :  Initiates the request to transfer the legacy subscriptions or RIs.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/initiateTransfer
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
body:
{
Description: Initiate transfer parameters. ,
Required: True ,
}
{
properties:
{
Description: Request parameters to initiate transfer. ,
Required: False ,
}
{
billingProfileId:
{
Description: Target Usage context for devTest subscriptions. ,
Required: False ,
}
string ,
recipientEmailId:
{
Description: Email Id of recipient for transfer. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: Transfer creation time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Transfer expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Target invoice section Id. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: Target billing account Id. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: Email Id of recipient of transfer. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: Email Id of initiator of transfer. ,
Required: False ,
}
string ,
canceledBy:
{
Description: Email Id who user canceled the transfer. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Transfer last modification time. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product being transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: Id of product being transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Transfers_Get (removed)
Description :  Gets the transfer details for given transfer Id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/transfers/{transferName}
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
transferName:
{
Description: Transfer Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: Transfer creation time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Transfer expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Target invoice section Id. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: Target billing account Id. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: Email Id of recipient of transfer. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: Email Id of initiator of transfer. ,
Required: False ,
}
string ,
canceledBy:
{
Description: Email Id who user canceled the transfer. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Transfer last modification time. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product being transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: Id of product being transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Transfers_Cancel (removed)
Description :  Cancels the transfer for given transfer Id.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/transfers/{transferName}
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
transferName:
{
Description: Transfer Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: Transfer creation time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Transfer expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Target invoice section Id. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: Target billing account Id. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: Email Id of recipient of transfer. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: Email Id of initiator of transfer. ,
Required: False ,
}
string ,
canceledBy:
{
Description: Email Id who user canceled the transfer. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Transfer last modification time. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product being transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: Id of product being transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Transfers_List (removed)
Description :  Lists all transfer's details initiated from given invoice section.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/transfers
{
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of transfers initiated by caller. ,
Required: False ,
}
[
{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: Transfer creation time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Transfer expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: Target invoice section Id. ,
Required: False ,
}
string ,
billingAccountId:
{
Description: Target billing account Id. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: Email Id of recipient of transfer. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: Email Id of initiator of transfer. ,
Required: False ,
}
string ,
canceledBy:
{
Description: Email Id who user canceled the transfer. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Transfer last modification time. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product being transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: Id of product being transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

POST:  /providers/Microsoft.Billing/transfers/{transferName}/acceptTransfer
{
transferName:
{
Description: Transfer Name. ,
Required: True ,
}
string ,
body:
{
Description: Accept transfer parameters. ,
Required: True ,
}
{
properties:
{
Description: Request parameters to accept transfer. ,
Required: False ,
}
{
productDetails:
{
Description: Request parameters to accept transfer. ,
Required: False ,
}
[
{
productType:
{
Description: Type of the product to be transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: Id of product to be transferred. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: Transfer creation time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Transfer expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
allowedProductType:
{
Description: Type of subscriptions that can be transferred. ,
Required: False ,
}
[
string ,
]
,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: Email Id of recipient of transfer. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: Email Id of initiator of transfer. ,
Required: False ,
}
string ,
canceledBy:
{
Description: Email Id who user canceled the transfer. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Transfer last modification time. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product being transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: Id of product being transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

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

⚼ Request

POST:  /providers/Microsoft.Billing/transfers/{transferName}/declineTransfer
{
transferName:
{
Description: Transfer Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: Transfer creation time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Transfer expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
allowedProductType:
{
Description: Type of subscriptions that can be transferred. ,
Required: False ,
}
[
string ,
]
,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: Email Id of recipient of transfer. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: Email Id of initiator of transfer. ,
Required: False ,
}
string ,
canceledBy:
{
Description: Email Id who user canceled the transfer. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Transfer last modification time. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product being transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: Id of product being transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
RecipientTransfers_Get (removed)
Description :  Gets the transfer with given transfer Id.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/transfers/{transferName}/
{
transferName:
{
Description: Transfer Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: Transfer creation time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Transfer expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
allowedProductType:
{
Description: Type of subscriptions that can be transferred. ,
Required: False ,
}
[
string ,
]
,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: Email Id of recipient of transfer. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: Email Id of initiator of transfer. ,
Required: False ,
}
string ,
canceledBy:
{
Description: Email Id who user canceled the transfer. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Transfer last modification time. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product being transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: Id of product being transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of transfers received by caller. ,
Required: False ,
}
[
{
properties:
{
Description: Details of the transfer. ,
Required: False ,
}
{
creationTime:
{
Description: Transfer creation time. ,
Format: date-time ,
Required: False ,
}
string ,
expirationTime:
{
Description: Transfer expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
allowedProductType:
{
Description: Type of subscriptions that can be transferred. ,
Required: False ,
}
[
string ,
]
,
transferStatus:
{
Description: Overall transfer status. ,
Enum:
{
Pending: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
CompletedWithErrors: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Declined: No description available. ,
}
,
Required: False ,
}
enum ,
recipientEmailId:
{
Description: Email Id of recipient of transfer. ,
Required: False ,
}
string ,
initiatorEmailId:
{
Description: Email Id of initiator of transfer. ,
Required: False ,
}
string ,
canceledBy:
{
Description: Email Id who user canceled the transfer. ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Transfer last modification time. ,
Format: date-time ,
Required: False ,
}
string ,
detailedTransferStatus:
{
Description: Detailed transfer status. ,
Required: False ,
}
[
{
productType:
{
Description: Type of product being transferred. ,
Enum:
{
AzureSubscription: No description available. ,
AzureReservation: No description available. ,
}
,
Required: False ,
}
enum ,
productId:
{
Description: Id of product being transferred. ,
Required: False ,
}
string ,
transferStatus:
{
Description: Transfer status. ,
Enum:
{
NotStarted: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details for transfer execution. ,
Required: False ,
}
{
errorCode:
{
Description: Error code. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of billing operations supported by the Microsoft.Billing resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.Billing. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Invoice, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
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 ,
}
,
}
BillingPermissions_ListByBillingAccount (removed)
Description :  Lists all billing permissions for the caller under a billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/providers/Microsoft.Billing/billingPermissions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
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 do ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions the caller is not allowed to do ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_ListByCustomers (removed)
Description :  Lists all billing permissions for the caller under customer.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/providers/Microsoft.Billing/billingPermissions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
customerName:
{
Description: Customer Id. ,
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 do ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions the caller is not allowed to do ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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 all billing permissions for the caller under invoice section.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Billing/billingPermissions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
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 do ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions the caller is not allowed to do ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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 all billingPermissions for the caller has for a billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Billing/billingPermissions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
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 do ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions the caller is not allowed to do ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_GetByBillingAccountName (removed)
Description :  Gets the role definition for a role
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/providers/Microsoft.Billing/billingRoleDefinitions/{billingRoleDefinitionName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingRoleDefinitionName:
{
Description: role definition id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The role definition for a role. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
{
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 do ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions the caller is not allowed to do ,
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 ,
}
,
}
BillingRoleDefinitions_GetByInvoiceSectionName (removed)
Description :  Gets the role definition for a role
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Billing/billingRoleDefinitions/{billingRoleDefinitionName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
billingRoleDefinitionName:
{
Description: role definition id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The role definition for a role. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
{
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 do ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions the caller is not allowed to do ,
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 ,
}
,
}
BillingRoleDefinitions_GetByBillingProfileName (removed)
Description :  Gets the role definition for a role
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Billing/billingRoleDefinitions/{billingRoleDefinitionName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
billingRoleDefinitionName:
{
Description: role definition id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The role definition for a role. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
{
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 do ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions the caller is not allowed to do ,
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 ,
}
,
}
BillingRoleDefinitions_ListByBillingAccountName (removed)
Description :  Lists the role definition for a billing account
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/providers/Microsoft.Billing/billingRoleDefinitions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of role definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The role definition for a role. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
{
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 do ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions the caller is not allowed to do ,
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 ,
}
,
}
BillingRoleDefinitions_ListByInvoiceSectionName (removed)
Description :  Lists the role definition for an invoice Section
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Billing/billingRoleDefinitions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of role definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The role definition for a role. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
{
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 do ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions the caller is not allowed to do ,
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 ,
}
,
}
BillingRoleDefinitions_ListByBillingProfileName (removed)
Description :  Lists the role definition for a Billing Profile
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Billing/billingRoleDefinitions
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of role definitions. ,
Required: False ,
}
[
{
properties:
{
Description: The role definition for a role. ,
Required: False ,
}
{
description:
{
Description: The role description ,
Required: False ,
}
string ,
permissions:
{
Description: The billingPermissions the role has ,
Required: False ,
}
{
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 do ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: The set of actions the caller is not allowed to do ,
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 ,
}
,
}
BillingRoleAssignments_GetByBillingAccount (removed)
Description :  Get the role assignment for the caller
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/providers/Microsoft.Billing/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: role assignment id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The role assignment the caller has ,
Required: False ,
}
{
createdOn:
{
Description: the date the role assignment is created ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: the creator's tenant Id ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: the creator's principal Id ,
Required: False ,
}
string ,
name:
{
Description: the name of the role assignment ,
Required: False ,
}
string ,
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
roleDefinitionName:
{
Description: The role definition id ,
Required: False ,
}
string ,
scope:
{
Description: The scope the role get assigned to ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_DeleteByBillingAccountName (removed)
Description :  Delete the role assignment on this billing account
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/providers/Microsoft.Billing/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: role assignment id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The role assignment the caller has ,
Required: False ,
}
{
createdOn:
{
Description: the date the role assignment is created ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: the creator's tenant Id ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: the creator's principal Id ,
Required: False ,
}
string ,
name:
{
Description: the name of the role assignment ,
Required: False ,
}
string ,
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
roleDefinitionName:
{
Description: The role definition id ,
Required: False ,
}
string ,
scope:
{
Description: The scope the role get assigned to ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_GetByInvoiceSectionName (removed)
Description :  Get the role assignment for the caller on the invoice Section
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Billing/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: role assignment id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The role assignment the caller has ,
Required: False ,
}
{
createdOn:
{
Description: the date the role assignment is created ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: the creator's tenant Id ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: the creator's principal Id ,
Required: False ,
}
string ,
name:
{
Description: the name of the role assignment ,
Required: False ,
}
string ,
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
roleDefinitionName:
{
Description: The role definition id ,
Required: False ,
}
string ,
scope:
{
Description: The scope the role get assigned to ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_DeleteByInvoiceSectionName (removed)
Description :  Delete the role assignment on the invoice Section
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Billing/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: role assignment id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The role assignment the caller has ,
Required: False ,
}
{
createdOn:
{
Description: the date the role assignment is created ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: the creator's tenant Id ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: the creator's principal Id ,
Required: False ,
}
string ,
name:
{
Description: the name of the role assignment ,
Required: False ,
}
string ,
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
roleDefinitionName:
{
Description: The role definition id ,
Required: False ,
}
string ,
scope:
{
Description: The scope the role get assigned to ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_GetByBillingProfileName (removed)
Description :  Get the role assignment for the caller on the Billing Profile
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Billing/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: role assignment id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The role assignment the caller has ,
Required: False ,
}
{
createdOn:
{
Description: the date the role assignment is created ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: the creator's tenant Id ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: the creator's principal Id ,
Required: False ,
}
string ,
name:
{
Description: the name of the role assignment ,
Required: False ,
}
string ,
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
roleDefinitionName:
{
Description: The role definition id ,
Required: False ,
}
string ,
scope:
{
Description: The scope the role get assigned to ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_DeleteByBillingProfileName (removed)
Description :  Delete the role assignment on this Billing Profile
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Billing/billingRoleAssignments/{billingRoleAssignmentName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
billingRoleAssignmentName:
{
Description: role assignment id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The role assignment the caller has ,
Required: False ,
}
{
createdOn:
{
Description: the date the role assignment is created ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: the creator's tenant Id ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: the creator's principal Id ,
Required: False ,
}
string ,
name:
{
Description: the name of the role assignment ,
Required: False ,
}
string ,
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
roleDefinitionName:
{
Description: The role definition id ,
Required: False ,
}
string ,
scope:
{
Description: The scope the role get assigned to ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_ListByBillingAccountName (removed)
Description :  Get the role assignments on the Billing Account
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/providers/Microsoft.Billing/billingRoleAssignments
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list role assignments ,
Required: False ,
}
[
{
properties:
{
Description: The role assignment the caller has ,
Required: False ,
}
{
createdOn:
{
Description: the date the role assignment is created ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: the creator's tenant Id ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: the creator's principal Id ,
Required: False ,
}
string ,
name:
{
Description: the name of the role assignment ,
Required: False ,
}
string ,
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
roleDefinitionName:
{
Description: The role definition id ,
Required: False ,
}
string ,
scope:
{
Description: The scope the role get assigned to ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_AddByBillingAccountName (removed)
Description :  The operation to add a role assignment to a billing account.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/providers/Microsoft.Billing/createBillingRoleAssignment
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to add a role assignment. ,
Required: True ,
}
{
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
billingRoleDefinitionId:
{
Description: The role definition id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
value:
{
Description: The list role assignments ,
Required: False ,
}
[
{
properties:
{
Description: The role assignment the caller has ,
Required: False ,
}
{
createdOn:
{
Description: the date the role assignment is created ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: the creator's tenant Id ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: the creator's principal Id ,
Required: False ,
}
string ,
name:
{
Description: the name of the role assignment ,
Required: False ,
}
string ,
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
roleDefinitionName:
{
Description: The role definition id ,
Required: False ,
}
string ,
scope:
{
Description: The scope the role get assigned to ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_ListByInvoiceSectionName (removed)
Description :  Get the role assignments on the invoice Section
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Billing/billingRoleAssignments
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list role assignments ,
Required: False ,
}
[
{
properties:
{
Description: The role assignment the caller has ,
Required: False ,
}
{
createdOn:
{
Description: the date the role assignment is created ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: the creator's tenant Id ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: the creator's principal Id ,
Required: False ,
}
string ,
name:
{
Description: the name of the role assignment ,
Required: False ,
}
string ,
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
roleDefinitionName:
{
Description: The role definition id ,
Required: False ,
}
string ,
scope:
{
Description: The scope the role get assigned to ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_AddByInvoiceSectionName (removed)
Description :  The operation to add a role assignment to a invoice Section.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Billing/createBillingRoleAssignment
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
invoiceSectionName:
{
Description: InvoiceSection Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to add a role assignment. ,
Required: True ,
}
{
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
billingRoleDefinitionId:
{
Description: The role definition id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
value:
{
Description: The list role assignments ,
Required: False ,
}
[
{
properties:
{
Description: The role assignment the caller has ,
Required: False ,
}
{
createdOn:
{
Description: the date the role assignment is created ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: the creator's tenant Id ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: the creator's principal Id ,
Required: False ,
}
string ,
name:
{
Description: the name of the role assignment ,
Required: False ,
}
string ,
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
roleDefinitionName:
{
Description: The role definition id ,
Required: False ,
}
string ,
scope:
{
Description: The scope the role get assigned to ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_ListByBillingProfileName (removed)
Description :  Get the role assignments on the Billing Profile
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Billing/billingRoleAssignments
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list role assignments ,
Required: False ,
}
[
{
properties:
{
Description: The role assignment the caller has ,
Required: False ,
}
{
createdOn:
{
Description: the date the role assignment is created ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: the creator's tenant Id ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: the creator's principal Id ,
Required: False ,
}
string ,
name:
{
Description: the name of the role assignment ,
Required: False ,
}
string ,
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
roleDefinitionName:
{
Description: The role definition id ,
Required: False ,
}
string ,
scope:
{
Description: The scope the role get assigned to ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_AddByBillingProfileName (removed)
Description :  The operation to add a role assignment to a billing profile.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.Billing/createBillingRoleAssignment
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to add a role assignment. ,
Required: True ,
}
{
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
billingRoleDefinitionId:
{
Description: The role definition id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
value:
{
Description: The list role assignments ,
Required: False ,
}
[
{
properties:
{
Description: The role assignment the caller has ,
Required: False ,
}
{
createdOn:
{
Description: the date the role assignment is created ,
Required: False ,
}
string ,
createdByPrincipalTenantId:
{
Description: the creator's tenant Id ,
Required: False ,
}
string ,
createdByPrincipalId:
{
Description: the creator's principal Id ,
Required: False ,
}
string ,
name:
{
Description: the name of the role assignment ,
Required: False ,
}
string ,
principalId:
{
Description: The user's principal id that the role gets assigned to ,
Required: False ,
}
string ,
roleDefinitionName:
{
Description: The role definition id ,
Required: False ,
}
string ,
scope:
{
Description: The scope the role get assigned to ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
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_ListByBillingAccountName (removed)
Description :  Lists all agreements for a billing account.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
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: An agreement. ,
Required: False ,
}
{
agreementLink:
{
Description: The link to the agreement. ,
Required: False ,
}
string ,
effectiveDate:
{
Description: Effective date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
participants:
{
Description: Participants or signer of the agreement. ,
Required: False ,
}
[
{
status:
{
Description: The signing status ,
Required: False ,
}
string ,
statusDate:
{
Description: The date when status got changed. ,
Format: date-time ,
Required: False ,
}
string ,
email:
{
Description: The email address of the participant or signer. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The agreement status ,
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 ,
}
,
}
Agreements_Get (removed)
Description :  Get the agreement by name.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements/{agreementName}
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: Billing Account Id. ,
Required: True ,
}
string ,
agreementName:
{
Description: Agreement Id. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the participants. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: An agreement. ,
Required: False ,
}
{
agreementLink:
{
Description: The link to the agreement. ,
Required: False ,
}
string ,
effectiveDate:
{
Description: Effective date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Expiration date. ,
Format: date-time ,
Required: False ,
}
string ,
participants:
{
Description: Participants or signer of the agreement. ,
Required: False ,
}
[
{
status:
{
Description: The signing status ,
Required: False ,
}
string ,
statusDate:
{
Description: The date when status got changed. ,
Format: date-time ,
Required: False ,
}
string ,
email:
{
Description: The email address of the participant or signer. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: The agreement status ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
LineOfCredits_Get (removed)
Description :  Get the current line of credit.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingAccounts/default/lineOfCredit/default
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A line of credit. ,
Required: False ,
}
{
creditLimit:
{
Description: The current credit limit. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
reason:
{
Description: The reason for the line of credit status when not approved. ,
Required: False ,
}
string ,
remainingBalance:
{
Description: Remaining balance. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
status:
{
Description: The line of credit status. ,
Enum:
{
Approved: No description available. ,
Rejected: 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 ,
}
,
}
LineOfCredits_Update (removed)
Description :  Increase the current line of credit.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingAccounts/default/lineOfCredit/default
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the increase line of credit operation. ,
Required: True ,
}
{
properties:
{
Description: A line of credit. ,
Required: False ,
}
{
creditLimit:
{
Description: The current credit limit. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
reason:
{
Description: The reason for the line of credit status when not approved. ,
Required: False ,
}
string ,
remainingBalance:
{
Description: Remaining balance. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
status:
{
Description: The line of credit status. ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: A line of credit. ,
Required: False ,
}
{
creditLimit:
{
Description: The current credit limit. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
reason:
{
Description: The reason for the line of credit status when not approved. ,
Required: False ,
}
string ,
remainingBalance:
{
Description: Remaining balance. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
status:
{
Description: The line of credit status. ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: Location URI to poll for result. ,
}
string ,
retry-after:
{
Description: Recommends the retryable time after receiving this. ,
}
integer ,
azure-asyncoperation:
{
Description: URI to poll for the operation status ,
}
string ,
}

⚐ Response (default)

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